@sixtyninecommerce/admin 0.10.0 → 0.12.0

package/dist/orders/fields.d.ts

@@ -0,0 +1,245 @@
+/**
+ * The order page's own fields (headless spec §9.2 `orders` "notes", "fulfilments"; W10-26): the
+ * order's notes, its purchase-order number, its customer, its goodwill rounding, and the
+ * correction of what a fulfilment shipped.
+ *
+ * Whether an order still takes a goodwill rounding or a fulfilment correction is
+ * `orders.status(orderId).actions` (`APPLY_GOODWILL_ROUNDING` to apply one,
+ * `SET_GOODWILL_ROUNDING` to clear it, `CORRECT_FULFILLMENT`): ask it before offering one.
+ */
+import { type Transport } from '@sixtyninecommerce/core';
+import type { Call } from '../types.js';
+/** A staff note on an order. Listed with the order's history (`orders.get`, type `ORDER_NOTE`). */
+export interface OrderNote {
+    id: string;
+    note: string;
+    /** Whether the customer sees it (the storefront's order history). */
+    isPublic: boolean;
+    /** ISO-8601 with offset. */
+    createdAt: string;
+    /** ISO-8601 with offset. */
+    updatedAt: string;
+}
+export interface OrderNoteInput {
+    note: string;
+    /** Whether the customer sees it. Default false: a note is for staff unless you say otherwise. */
+    isPublic?: boolean;
+}
+export interface OrderNotesModule {
+    /**
+     * Add a note to the order's history. Needs `UpdateOrder`. A locked, completed or cancelled
+     * order still takes notes.
+     *
+     * It resolves with nothing: the engine answers the order, not the note. The note's id (for
+     * `update` and `delete`) is on `orders.get(orderId).history`, newest first, type `ORDER_NOTE`.
+     * An order this store does not hold is a `NotFoundError` (`ENTITY_NOT_FOUND`).
+     *
+     * @effect write
+     */
+    add(orderId: string, input: OrderNoteInput, options?: Call): Promise<void>;
+    /**
+     * Change a note's text, who sees it, or both; what is left out is kept. Needs `UpdateOrder`.
+     * An id that is not a note of this store is a `NotFoundError` (`ENTITY_NOT_FOUND`), the same
+     * as a missing one.
+     *
+     * @effect write
+     */
+    update(noteId: string, input: {
+        note?: string;
+        isPublic?: boolean;
+    }, options?: Call): Promise<OrderNote>;
+    /**
+     * Delete a note for good. Needs `UpdateOrder`.
+     *
+     * Refused `ORDER_NOTE_NOT_DELETED` (`ConflictError`, 409, as every `*_NOT_DELETED` of this
+     * SDK) with the engine's own reason: a note this store does not have, or a history entry that
+     * records a decision about the order (a payment coverage override, money kept on a cancelled
+     * order), which stays on its history.
+     *
+     * @effect destructive
+     */
+    delete(noteId: string, options?: Call): Promise<void>;
+}
+/** The order's purchase-order number as a write leaves it. */
+export interface OrderPurchaseOrderNumber {
+    orderId: string;
+    /** Null when the order carries none. */
+    purchaseOrderNumber: string | null;
+}
+/** The order's customer as `setCustomer` leaves it. */
+export interface OrderCustomerAssignment {
+    orderId: string;
+    customer: {
+        id: string;
+        firstName: string;
+        lastName: string;
+        emailAddress: string;
+    } | null;
+}
+/** The order's total and its goodwill rounding as a write leaves them. */
+export interface OrderGoodwillRounding {
+    orderId: string;
+    code: string;
+    currencyCode: string;
+    /** The order's gross total in minor units, BEFORE the rounding. */
+    totalWithTax: number;
+    /**
+     * The rounding in minor units: negative while one is applied (`-87` takes 0.87 off), null
+     * when there is none. What the order bills is `totalWithTax` plus this.
+     */
+    goodwillRoundingMinor: number | null;
+}
+/** Where the units taken out of a fulfilment went. There is no default. */
+export type FulfillmentUnitDisposition = 'RETURN_TO_STOCK' | 'WRITE_OFF';
+export interface FulfillmentQuantityCorrectionLine {
+    orderLineId: string;
+    /** What actually shipped: 0 up to the line's quantity in the fulfilment. It never rises. */
+    quantity: number;
+    /**
+     * Also lower the ORDERED quantity by the same amount, so the customer is billed for what
+     * shipped. Leave it out when the balance follows in a later fulfilment.
+     */
+    reduceOrderLine?: boolean;
+}
+export interface FulfillmentQuantityCorrectionInput {
+    fulfillmentId: string;
+    /** The lines that change. A line left at its quantity may be left out. */
+    lines: readonly FulfillmentQuantityCorrectionLine[];
+    /**
+     * `RETURN_TO_STOCK`: the units are back on the shelf and sellable. `WRITE_OFF`: they are gone
+     * (miscounted, broken, lost) and stock on hand does not rise.
+     */
+    disposition: FulfillmentUnitDisposition | (string & {});
+    /** Why, for the order's history. */
+    reason?: string | null;
+}
+/** The fulfilment as a correction leaves it. */
+export interface FulfillmentQuantityCorrection {
+    fulfillmentId: string;
+    state: string;
+    lines: Array<{
+        orderLineId: string;
+        quantity: number;
+    }>;
+}
+export interface OrderFieldsModule {
+    /** The order's staff notes: add, change, delete. */
+    notes: OrderNotesModule;
+    /**
+     * Set the order's purchase-order number (the buyer's own reference, printed on the invoice's
+     * "Reference" row), or clear it with `null` or an empty string. Needs `UpdateOrder`. An
+     * invoiced order still takes it: it prints on the NEXT invoice.
+     *
+     * Refused `ORDER_PO_NUMBER_INVALID` (`ValidationError`, 400) for a value over 255 characters;
+     * `error.details[0].field` is `/input/customFields/poNumber`. An order this store does not
+     * hold is a `NotFoundError` (`ENTITY_NOT_FOUND`). An engine older than the code answers the
+     * same refusal as `USER_INPUT_ERROR` (also a `ValidationError`), with no `details`.
+     *
+     * @effect write
+     */
+    setPurchaseOrderNumber(orderId: string, value: string | null, options?: Call): Promise<OrderPurchaseOrderNumber>;
+    /**
+     * Move the order to another customer of the store. Needs `UpdateOrder`. `options.note` is
+     * kept with the change on the order's history. Naming the customer the order already has
+     * changes nothing.
+     *
+     * Refused with the engine's sentence (`ValidationError`, `USER_INPUT_ERROR`, 400) while the
+     * order's content no longer changes (an invoice bills it, or it is completed or cancelled:
+     * `orders.status(orderId).editBlock`), and once delivery terms were accepted for it. An
+     * order or a customer this store does not hold is a `NotFoundError` (`ENTITY_NOT_FOUND`).
+     *
+     * @effect write
+     */
+    setCustomer(orderId: string, customerId: string, options?: Call & {
+        note?: string;
+    }): Promise<OrderCustomerAssignment>;
+    /**
+     * Round the order's payable total DOWN to a whole currency unit as a courtesy (`apply:
+     * true`), or take the rounding off again (`false`). Needs `UpdateOrder`.
+     *
+     * **It changes what the order bills.** The engine computes the amount from the order's own
+     * gross total: this method takes none. The rounding is stored beside the total (the
+     * order's lines and `totalWithTax` do not change), and the order's invoice, its payment
+     * position (`orders.paymentPosition`) and the accounts-receivable ledger all bill
+     * `totalWithTax + goodwillRoundingMinor`. It moves no payment and issues no refund. Applied
+     * again after the total changed, it is recomputed.
+     *
+     * Refused, with nothing changed:
+     * - `GOODWILL_ROUNDING_LOCKED` (422), either way, once the order's total no longer moves: an
+     *   invoice bills it, it is completed or cancelled, or it is settled or invoiced in the
+     *   store's ERP. `orders.status` answers the same rule (`SET_GOODWILL_ROUNDING`:
+     *   `INVOICE_LOCKED`, `COMPLETED`, `CANCELLED`, `ERP_LOCKED`);
+     * - `GOODWILL_ROUNDING_NOT_APPLICABLE` (422), applying only: the order has more than one VAT
+     *   rate (the rounding is booked at a single rate), or its total is already whole;
+     * - `GOODWILL_ROUNDING_LEAVES_MONEY_OVER` (422), applying only: the order is paid, and its
+     *   payments would hold more than the rounded total. The rounding refunds nothing, so that
+     *   money would stay over: refund the customer instead. `orders.status` answers it
+     *   (`APPLY_GOODWILL_ROUNDING`: `LEAVES_MONEY_OVER`);
+     * - `ORDER_MONEY_ACTION_IN_PROGRESS` (409, retryable), either way: a return's settlement or an
+     *   invoice correction of the order held its money turn past the wait. Try again.
+     *
+     * An order this store does not hold is a `NotFoundError` (`ENTITY_NOT_FOUND`). An engine
+     * older than these codes answers the same refusals with their sentence and no code (a 500).
+     *
+     * @effect money
+     */
+    setGoodwillRounding(orderId: string, apply: boolean, options?: Call): Promise<OrderGoodwillRounding>;
+    /**
+     * Record what a fulfilment ACTUALLY shipped after a short pick: lower its line quantities,
+     * move the stock the `disposition` implies, and, per line, optionally lower what the customer
+     * is billed for (`reduceOrderLine`), all in one step. Needs `UpdateOrder`. It notes the
+     * correction on the order's history and tells no carrier.
+     *
+     * **`reduceOrderLine` changes what the order bills, and it issues NO refund.** It is refused
+     * once the order's payment holds money (see below): correct the fulfilment without it, then
+     * give the money back through an order edit. Without `reduceOrderLine` the order keeps asking
+     * for the units, as a split shipment needs.
+     *
+     * **This is the order page's door.** The warehouse workspace has its own
+     * (`correctFulfillmentQuantities`, for a caller holding `UpdateFulfillment`, scoped to the
+     * warehouses they are assigned to, and never billing down): `orders.status` explains both
+     * under `CORRECT_FULFILLMENT`. Whether THIS fulfilment can still be corrected is its own
+     * stage (Pending or Picking, or Packed with no carrier booking).
+     *
+     * **Idempotency.** With `options.idempotencyKey`, repeating the same correction answers the
+     * first one's fulfilment instead of removing the units a second time; another correction
+     * under that key is `IDEMPOTENCY_CONFLICT` (409). Without a key a repeat is a second
+     * correction.
+     *
+     * Refused, with nothing changed:
+     * - `FULFILLMENT_QUANTITY_INPUT_INVALID` (`ValidationError`, 400): no lines, a line named
+     *   twice or not in the fulfilment, a quantity that is not a whole number of 0 or more or
+     *   that rises, or a correction that changes nothing;
+     * - `FULFILLMENT_QUANTITY_NOT_CORRECTABLE` (422): the fulfilment has shipped, a carrier
+     *   booking fixes its contents, or the correction would empty it (cancel it instead);
+     * - `FULFILLMENT_QUANTITY_ORDER_LOCKED` (422): an invoice bills the order, or it is
+     *   completed or cancelled (`orders.status(orderId).fulfillmentCorrection`);
+     * - `FULFILLMENT_QUANTITY_BILL_DOWN_REFUSED` (422), `reduceOrderLine` only: the order's
+     *   payment is settled or held by a payment provider, or its method is no longer on the
+     *   store so it cannot be shown to hold no money;
+     * - `ORDER_BILLING_LOCKED` (422), `reduceOrderLine` only: the order was sent to an ERP that
+     *   takes no later change;
+     * - `FULFILLMENT_QUANTITY_CONFLICT` (`ConflictError`, 409): the fulfilment or the order
+     *   changed meanwhile. Read the order again and correct what it shows now;
+     * - `FULFILLMENT_CHANGED` (retryable): another change to the fulfilment was in progress;
+     * - `LOCATION_OUT_OF_SCOPE` (422), for a credential restricted to stock locations (an API
+     *   token or app installation with `locationIds`) only: the fulfilment does not ship from one
+     *   of them (one with no recorded warehouse included). It reads like a missing fulfilment, and
+     *   the key is not spent on it.
+     *
+     * A fulfilment this store does not hold is a `NotFoundError` (`ENTITY_NOT_FOUND`). Platform
+     * releases before this method do not take the key and refuse the call as `ValidationError`
+     * `GRAPHQL_VALIDATION_FAILED` (400): deploy the engine first.
+     *
+     * @effect money
+     */
+    correctFulfillmentQuantities(input: FulfillmentQuantityCorrectionInput, options?: Call): Promise<FulfillmentQuantityCorrection>;
+}
+export declare const ADD_ORDER_NOTE_MUTATION = "\n  mutation AddNoteToOrder($input: AddNoteToOrderInput!) {\n    addNoteToOrder(input: $input) {\n      id\n    }\n  }\n";
+export declare const UPDATE_ORDER_NOTE_MUTATION = "\n  mutation UpdateOrderNote($input: UpdateOrderNoteInput!) {\n    updateOrderNote(input: $input) {\n      id\n      isPublic\n      data\n      createdAt\n      updatedAt\n    }\n  }\n";
+export declare const DELETE_ORDER_NOTE_MUTATION = "\n  mutation DeleteOrderNote($id: ID!) {\n    deleteOrderNote(id: $id) {\n      result\n      message\n    }\n  }\n";
+export declare const SET_ORDER_PURCHASE_ORDER_NUMBER_MUTATION = "\n  mutation SetOrderPurchaseOrderNumber($input: UpdateOrderInput!) {\n    setOrderCustomFields(input: $input) {\n      id\n      customFields {\n        poNumber\n      }\n    }\n  }\n";
+export declare const SET_ORDER_CUSTOMER_MUTATION = "\n  mutation SetOrderCustomer($input: SetOrderCustomerInput!) {\n    setOrderCustomer(input: $input) {\n      id\n      customer {\n        id\n        firstName\n        lastName\n        emailAddress\n      }\n    }\n  }\n";
+export declare const SET_ORDER_GOODWILL_ROUNDING_MUTATION = "\n  mutation SetOrderGoodwillRounding($orderId: ID!, $apply: Boolean!) {\n    setOrderGoodwillRounding(orderId: $orderId, apply: $apply) {\n      id\n      code\n      currencyCode\n      totalWithTax\n      customFields {\n        goodwillRoundingMinor\n      }\n    }\n  }\n";
+export declare const CORRECT_FULFILLMENT_QUANTITIES_MUTATION = "\n  mutation UpdateFulfillmentLineQuantities(\n    $fulfillmentId: ID!\n    $lines: [UpdateFulfillmentLineQuantityInput!]!\n    $disposition: FulfillmentUnitDisposition!\n    $reason: String\n    $idempotencyKey: String\n  ) {\n    updateFulfillmentLineQuantities(\n      fulfillmentId: $fulfillmentId\n      lines: $lines\n      disposition: $disposition\n      reason: $reason\n      idempotencyKey: $idempotencyKey\n    ) {\n      id\n      state\n      lines {\n        orderLineId\n        quantity\n      }\n    }\n  }\n";
+export declare function createOrderFieldsModule(transport: Transport): OrderFieldsModule;

package/dist/orders/fields.js

@@ -0,0 +1,188 @@
+/**
+ * The order page's own fields (headless spec §9.2 `orders` "notes", "fulfilments"; W10-26): the
+ * order's notes, its purchase-order number, its customer, its goodwill rounding, and the
+ * correction of what a fulfilment shipped.
+ *
+ * Whether an order still takes a goodwill rounding or a fulfilment correction is
+ * `orders.status(orderId).actions` (`APPLY_GOODWILL_ROUNDING` to apply one,
+ * `SET_GOODWILL_ROUNDING` to clear it, `CORRECT_FULFILLMENT`): ask it before offering one.
+ */
+import { NotFoundError } from '@sixtyninecommerce/core';
+import { assertDeleted, fieldOf } from '../catalog/types.js';
+export const ADD_ORDER_NOTE_MUTATION = /* GraphQL */ `
+  mutation AddNoteToOrder($input: AddNoteToOrderInput!) {
+    addNoteToOrder(input: $input) {
+      id
+    }
+  }
+`;
+export const UPDATE_ORDER_NOTE_MUTATION = /* GraphQL */ `
+  mutation UpdateOrderNote($input: UpdateOrderNoteInput!) {
+    updateOrderNote(input: $input) {
+      id
+      isPublic
+      data
+      createdAt
+      updatedAt
+    }
+  }
+`;
+export const DELETE_ORDER_NOTE_MUTATION = /* GraphQL */ `
+  mutation DeleteOrderNote($id: ID!) {
+    deleteOrderNote(id: $id) {
+      result
+      message
+    }
+  }
+`;
+export const SET_ORDER_PURCHASE_ORDER_NUMBER_MUTATION = /* GraphQL */ `
+  mutation SetOrderPurchaseOrderNumber($input: UpdateOrderInput!) {
+    setOrderCustomFields(input: $input) {
+      id
+      customFields {
+        poNumber
+      }
+    }
+  }
+`;
+export const SET_ORDER_CUSTOMER_MUTATION = /* GraphQL */ `
+  mutation SetOrderCustomer($input: SetOrderCustomerInput!) {
+    setOrderCustomer(input: $input) {
+      id
+      customer {
+        id
+        firstName
+        lastName
+        emailAddress
+      }
+    }
+  }
+`;
+export const SET_ORDER_GOODWILL_ROUNDING_MUTATION = /* GraphQL */ `
+  mutation SetOrderGoodwillRounding($orderId: ID!, $apply: Boolean!) {
+    setOrderGoodwillRounding(orderId: $orderId, apply: $apply) {
+      id
+      code
+      currencyCode
+      totalWithTax
+      customFields {
+        goodwillRoundingMinor
+      }
+    }
+  }
+`;
+export const CORRECT_FULFILLMENT_QUANTITIES_MUTATION = /* GraphQL */ `
+  mutation UpdateFulfillmentLineQuantities(
+    $fulfillmentId: ID!
+    $lines: [UpdateFulfillmentLineQuantityInput!]!
+    $disposition: FulfillmentUnitDisposition!
+    $reason: String
+    $idempotencyKey: String
+  ) {
+    updateFulfillmentLineQuantities(
+      fulfillmentId: $fulfillmentId
+      lines: $lines
+      disposition: $disposition
+      reason: $reason
+      idempotencyKey: $idempotencyKey
+    ) {
+      id
+      state
+      lines {
+        orderLineId
+        quantity
+      }
+    }
+  }
+`;
+function noteOf(entry) {
+    const text = entry.data?.note;
+    return {
+        id: entry.id,
+        note: typeof text === 'string' ? text : '',
+        isPublic: entry.isPublic,
+        createdAt: entry.createdAt,
+        updatedAt: entry.updatedAt,
+    };
+}
+/** The engine answers these two fields `null` for an order it could not return. */
+function orderOrNotFound(order, orderId) {
+    if (order !== null && order !== undefined)
+        return order;
+    throw new NotFoundError({
+        code: 'ORDER_NOT_FOUND',
+        message: `This store has no order ${orderId}.`,
+        status: 404,
+        service: 'vendure',
+    });
+}
+export function createOrderFieldsModule(transport) {
+    return {
+        notes: {
+            async add(orderId, input, options) {
+                await fieldOf(transport, ADD_ORDER_NOTE_MUTATION, 'addNoteToOrder', { input: { id: orderId, note: input.note, isPublic: input.isPublic ?? false } }, options);
+            },
+            async update(noteId, input, options) {
+                const entry = await fieldOf(transport, UPDATE_ORDER_NOTE_MUTATION, 'updateOrderNote', 
+                // `undefined`, never an explicit null: what is left out stays off the wire, and kept.
+                { input: { noteId, note: input.note, isPublic: input.isPublic } }, options);
+                return noteOf(entry);
+            },
+            async delete(noteId, options) {
+                assertDeleted('ORDER_NOTE_NOT_DELETED', [
+                    await fieldOf(transport, DELETE_ORDER_NOTE_MUTATION, 'deleteOrderNote', { id: noteId }, options),
+                ]);
+            },
+        },
+        async setPurchaseOrderNumber(orderId, value, options) {
+            const order = await fieldOf(transport, SET_ORDER_PURCHASE_ORDER_NUMBER_MUTATION, 'setOrderCustomFields', 
+            // An empty string and null both clear it; the engine stores null.
+            { input: { id: orderId, customFields: { poNumber: value === '' ? null : value } } }, options);
+            const found = orderOrNotFound(order, orderId);
+            const stored = found.customFields?.poNumber;
+            return {
+                orderId: found.id,
+                purchaseOrderNumber: typeof stored === 'string' && stored !== '' ? stored : null,
+            };
+        },
+        async setCustomer(orderId, customerId, options) {
+            const order = await fieldOf(transport, SET_ORDER_CUSTOMER_MUTATION, 'setOrderCustomer', 
+            // `undefined`, never an explicit null: an omitted note stays off the wire.
+            { input: { orderId, customerId, note: options?.note } }, options);
+            const found = orderOrNotFound(order, orderId);
+            return { orderId: found.id, customer: found.customer ?? null };
+        },
+        async setGoodwillRounding(orderId, apply, options) {
+            const order = await fieldOf(transport, SET_ORDER_GOODWILL_ROUNDING_MUTATION, 'setOrderGoodwillRounding', { orderId, apply }, options);
+            return {
+                orderId: order.id,
+                code: order.code,
+                currencyCode: order.currencyCode,
+                totalWithTax: order.totalWithTax,
+                goodwillRoundingMinor: order.customFields?.goodwillRoundingMinor ?? null,
+            };
+        },
+        async correctFulfillmentQuantities(input, options) {
+            const fulfillment = await fieldOf(transport, CORRECT_FULFILLMENT_QUANTITIES_MUTATION, 'updateFulfillmentLineQuantities', {
+                fulfillmentId: input.fulfillmentId,
+                lines: input.lines.map((line) => ({
+                    orderLineId: line.orderLineId,
+                    quantity: line.quantity,
+                    reduceOrderLine: line.reduceOrderLine === true,
+                })),
+                disposition: input.disposition,
+                reason: input.reason ?? null,
+                // `undefined`, never an explicit null: an omitted key stays off the wire.
+                idempotencyKey: options?.idempotencyKey,
+            }, options);
+            return {
+                fulfillmentId: fulfillment.id,
+                state: fulfillment.state,
+                lines: fulfillment.lines.map((line) => ({
+                    orderLineId: line.orderLineId,
+                    quantity: line.quantity,
+                })),
+            };
+        },
+    };
+}

package/dist/orders/get.d.ts

@@ -9,15 +9,15 @@
  * in `include`, so a caller reads only what it uses, and the core document
  * names no field an engine without that plugin lacks.
  *
- * Money is an integer in minor units of the order's currency, with three
- * exceptions that are NOT converted to it: a line's `productVariant.price` and
- * `priceWithTax` (the catalogue price in the currency of the request, which is
- * the store's default unless the call names another), and a line's
- * `customFields.cost` (the store's default currency). An instant is an ISO-8601
- * string with its offset.
+ * Money is an integer in minor units of the order's currency, with two
+ * exceptions that are NOT converted to it: a line's `productVariant.storePrice`
+ * (the catalogue price in the currency of the request, which is the store's
+ * default unless the call names another; its own `currencyCode` says which),
+ * and a line's `customFields.cost` (the store's default currency). An instant is
+ * an ISO-8601 string with its offset.
  */
 import { type Transport } from '@sixtyninecommerce/core';
-import type { InventoryFlag } from '../catalog/variants.js';
+import type { InventoryFlag, VariantStorePrice } from '../catalog/variants.js';
 import type { OrderDiscount } from '../pricing/index.js';
 import type { Call } from '../types.js';
 /**
@@ -140,15 +140,15 @@ export interface OrderLineVariant {
     sku: string;
     /**
      * The catalogue unit price today, net and gross: the retail price, before any
-     * price list or override, unlike the line's own `unitPrice`.
+     * price list or override, unlike the line's own `unitPrice`. Null when the
+     * store has no price for the variant any more; the line keeps its own prices.
      *
-     * NOT in the order's currency. It is in the currency of the request: the
-     * store's default, unless the call names another (`tenant.currency`). On an
-     * order in another currency, never subtract it from or compare it with the
-     * line's own prices.
+     * NOT in the order's currency. It is in the currency of the request
+     * (`storePrice.currencyCode`): the store's default, unless the call names
+     * another (`tenant.currency`). On an order in another currency, never
+     * subtract it from or compare it with the line's own prices.
      */
-    price: number;
-    priceWithTax: number;
+    storePrice: VariantStorePrice | null;
     stockOnHand: number;
     stockAllocated: number;
     /** How the variant tracks stock: its own setting, or the store's (`INHERIT`). */
@@ -570,16 +570,24 @@ export type Order<I extends OrderInclude = never> = {
      * Every promotion's discount on the order, one entry per promotion, amounts
      * negative: the line promotions and the order promotions' shares of the lines
      * and of shipping, added up per promotion. A line's own discounts are already
-     * in its `discountedLinePrice`, so do not add the two. The read selects these
-     * three fields of the pricing module's `OrderDiscount`;
-     * `pricing.discounts(orderId)` answers the rest.
+     * in its `discountedLinePrice`, and a promotion's share of shipping is already
+     * in `shipping` (that share is on `shippingLines[].discounts`, under the same
+     * `adjustmentSource`), so do not add the two. The read selects these four
+     * fields of the pricing module's `OrderDiscount`; `pricing.discounts(orderId)`
+     * answers the rest.
      */
-    discounts: Array<Pick<OrderDiscount, 'description' | 'amount' | 'amountWithTax'>>;
+    discounts: Array<Pick<OrderDiscount, 'adjustmentSource' | 'description' | 'amount' | 'amountWithTax'>>;
     shippingLines: Array<{
         shippingMethod: {
             id: string;
             name: string;
         };
+        /**
+         * The promotions' discounts on this shipping line, amounts negative, already
+         * in `shipping`. Each is part of the `discounts` entry of the same
+         * `adjustmentSource`.
+         */
+        discounts: Array<Pick<OrderDiscount, 'adjustmentSource' | 'amount' | 'amountWithTax'>>;
     }>;
     payments: OrderPayment[] | null;
     fulfillments: OrderFulfillment<I>[] | null;
@@ -640,7 +648,7 @@ export type Order<I extends OrderInclude = never> = {
  * the named blocks is included: an object whose every field belongs to a block
  * (an empty selection is not valid GraphQL).
  */
-export declare const ORDER_QUERY_EVERY_BLOCK = "\n  query Order($id: ID!) {\n    order(id: $id) {\n      id\n      code\n      state\n      active\n      total\n      totalWithTax\n      subTotal\n      subTotalWithTax\n      shipping\n      shippingWithTax\n      currencyCode\n      orderPlacedAt\n      #[paymentTerms\n      paymentTerms {\n        source\n        managedExternally\n        status\n        conditionCode\n        conditionDescription\n        summary\n        classification\n        paymentDays\n        paymentEndOfMonths\n        paymentMethod\n        percentage\n        discountPaymentDays\n        discountPercentage\n        paymentDiscountType\n        stale\n        syncedAt\n        error\n        resolvedAt\n        remoteConditionCode\n        remoteConfirmedAt\n        remoteMismatch\n      }\n      #]\n      #[deliveryTerms\n      deliveryTerms {\n        source\n        sourceScope\n        governingCustomerId\n        sourceCustomerId\n        managedExternally\n        status\n        shippingMethodStatus\n        policyStatus\n        summary\n        selectionSource\n        selectedShippingMethodId\n        selectedShippingMethodCode\n        selectedShippingMethodName\n        platformShippingMethodCode\n        platformShippingMethodName\n        platformShippingMethodDescription\n        platformShippingPrice\n        platformShippingPriceWithTax\n        preferredShippingMethodId\n        incotermStatus\n        incotermCode\n        incotermVersion\n        incotermAddress\n        incotermDescription\n        shippingLeadDays\n        deliveryAdvice\n        stale\n        syncedAt\n        warning\n        resolvedAt\n        remoteShippingMethodCode\n        remoteShippingMethodName\n        remoteIncotermCode\n        remoteIncotermVersion\n        remoteIncotermAddress\n        remoteDeliveryDate\n        remoteConfirmedAt\n        remoteMismatch\n      }\n      #]\n      couponCodes\n      customer {\n        id\n        firstName\n        lastName\n        emailAddress\n        phoneNumber\n        #[vatValidation|afas|parasut\n        customFields {\n          #[vatValidation\n          vatNumber\n          vatValidationStatus\n          #]\n          #[afas\n          afasVrId\n          afasOrgId\n          afasContactId\n          afasPersId\n          #]\n          #[parasut\n          parasutContactId\n          #]\n        }\n        #]\n        addresses {\n          id\n          fullName\n          company\n          streetLine1\n          streetLine2\n          city\n          postalCode\n          country {\n            code\n          }\n          defaultShippingAddress\n          defaultBillingAddress\n          #[afas\n          customFields {\n            afasAddressId\n          }\n          #]\n        }\n      }\n      lines {\n        id\n        quantity\n        unitPrice\n        unitPriceWithTax\n        listPriceIncludesTax\n        discountedUnitPrice\n        discountedUnitPriceWithTax\n        linePrice\n        linePriceWithTax\n        discountedLinePrice\n        discountedLinePriceWithTax\n        proratedLinePrice\n        proratedLinePriceWithTax\n        taxRate\n        productVariant {\n          id\n          name\n          sku\n          price\n          priceWithTax\n          stockOnHand\n          stockAllocated\n          trackInventory\n          outOfStockThreshold\n          useGlobalOutOfStockThreshold\n          stockLevels {\n            stockLocationId\n            stockOnHand\n            stockAllocated\n            stockLocation {\n              id\n              name\n            }\n          }\n          product {\n            id\n            name\n            featuredAsset {\n              id\n              preview\n            }\n          }\n        }\n        featuredAsset {\n          id\n          preview\n        }\n        #[lineAllocations\n        allocations {\n          id\n          stockLocation {\n            id\n            name\n          }\n          quantity\n        }\n        #]\n        outstandingAllocatedQuantity\n        outstandingAllocations {\n          stockLocationId\n          stockLocationName\n          quantity\n        }\n        customFields {\n          unitPriceOverride\n          priceOverrideReason\n          unitPriceImported\n          priceListId\n          priceListName\n          retailPrice\n          priceListPrice\n          priceListDiscountType\n          priceListDiscountValue\n          priceListDiscountChain\n          cost\n          preferredStockLocationId\n          backorderedQuantity\n        }\n      }\n      surcharges {\n        id\n        description\n        sku\n        price\n        priceWithTax\n        taxRate\n      }\n      discounts {\n        description\n        amount\n        amountWithTax\n      }\n      shippingLines {\n        shippingMethod {\n          id\n          name\n        }\n      }\n      payments {\n        id\n        state\n        method\n        amount\n        transactionId\n        createdAt\n        refunds {\n          id\n          state\n          total\n          reason\n        }\n      }\n      fulfillments {\n        id\n        state\n        nextStates\n        method\n        trackingCode\n        lines {\n          orderLineId\n          quantity\n        }\n        #[fulfillmentDetails\n        handlerCode\n        handlerName\n        handlerDetails {\n          label\n          value\n        }\n        packingSlips {\n          id\n          packingSlipNumber\n          fulfillmentId\n          languageCode\n          storageKey\n          createdAt\n        }\n        #]\n        stockLocationName\n        linkedOrders {\n          id\n          code\n        }\n        customFields {\n          #[myparcel\n          myparcelShipmentId\n          myparcelLabelStatus\n          myparcelLabelFormat\n          myparcelLabelUrlA4\n          myparcelLabelUrlA6\n          myparcelLabelLastError\n          myparcelLabelHandoff\n          #]\n          bookingStatus\n        }\n        createdAt\n      }\n      shippingAddress {\n        fullName\n        company\n        streetLine1\n        streetLine2\n        city\n        province\n        postalCode\n        country\n        countryCode\n        phoneNumber\n      }\n      billingAddress {\n        fullName\n        company\n        streetLine1\n        streetLine2\n        city\n        province\n        postalCode\n        country\n        countryCode\n        phoneNumber\n      }\n      history(options: { take: 50, sort: { createdAt: DESC } }) {\n        items {\n          id\n          type\n          data\n          createdAt\n          isPublic\n          administrator {\n            id\n            firstName\n            lastName\n          }\n        }\n      }\n      taxSummary {\n        description\n        taxRate\n        taxBase\n        taxTotal\n      }\n      nextStates\n      createdAt\n      updatedAt\n      customFields {\n        isLocked\n        externalOrderId\n        externalPlatform\n        sourceFulfillmentHandedOff\n        originalPlacedAt\n        sourceWarehouse\n        pickupLocation\n        allocationExpiresAt\n        goodwillRoundingMinor\n        removeTax\n        isGift\n        giftNote\n        hidePricesOnPackingSlip\n        poNumber\n        requestedDeliveryDate\n        orderNotes\n        customerShippingAddressId\n        customerBillingAddressId\n        shippingAddressIsTemporary\n        billingAddressIsTemporary\n        paymentStatus\n        fulfillmentStatus\n        returnStatus\n        lifecycleStatus\n        #[paymentTerms\n        paymentTermsDays\n        paymentConditionCode\n        #]\n        #[afas\n        afasSalesOrderId\n        afasDirectInvoiceOrNu\n        afasInvoiceNumber\n        afasInvoiceDate\n        afasLocked\n        afasLockReason\n        afasLastSyncAt\n        #]\n        #[parasut\n        parasutInvoiceId\n        parasutEInvoiceStatus\n        parasutEInvoiceUuid\n        parasutLastError\n        #]\n      }\n      fulfillmentHold {\n        reason\n        note\n        heldAt\n        heldByUserId\n        heldBy\n      }\n      #[priceList\n      priceList {\n        id\n        name\n        description\n        defaultDiscountBps\n        defaultDiscountAmount\n        entries {\n          id\n          variantId\n          discountType\n          discountValue\n        }\n      }\n      #]\n    }\n  }\n";
+export declare const ORDER_QUERY_EVERY_BLOCK = "\n  query Order($id: ID!) {\n    order(id: $id) {\n      id\n      code\n      state\n      active\n      total\n      totalWithTax\n      subTotal\n      subTotalWithTax\n      shipping\n      shippingWithTax\n      currencyCode\n      orderPlacedAt\n      #[paymentTerms\n      paymentTerms {\n        source\n        managedExternally\n        status\n        conditionCode\n        conditionDescription\n        summary\n        classification\n        paymentDays\n        paymentEndOfMonths\n        paymentMethod\n        percentage\n        discountPaymentDays\n        discountPercentage\n        paymentDiscountType\n        stale\n        syncedAt\n        error\n        resolvedAt\n        remoteConditionCode\n        remoteConfirmedAt\n        remoteMismatch\n      }\n      #]\n      #[deliveryTerms\n      deliveryTerms {\n        source\n        sourceScope\n        governingCustomerId\n        sourceCustomerId\n        managedExternally\n        status\n        shippingMethodStatus\n        policyStatus\n        summary\n        selectionSource\n        selectedShippingMethodId\n        selectedShippingMethodCode\n        selectedShippingMethodName\n        platformShippingMethodCode\n        platformShippingMethodName\n        platformShippingMethodDescription\n        platformShippingPrice\n        platformShippingPriceWithTax\n        preferredShippingMethodId\n        incotermStatus\n        incotermCode\n        incotermVersion\n        incotermAddress\n        incotermDescription\n        shippingLeadDays\n        deliveryAdvice\n        stale\n        syncedAt\n        warning\n        resolvedAt\n        remoteShippingMethodCode\n        remoteShippingMethodName\n        remoteIncotermCode\n        remoteIncotermVersion\n        remoteIncotermAddress\n        remoteDeliveryDate\n        remoteConfirmedAt\n        remoteMismatch\n      }\n      #]\n      couponCodes\n      customer {\n        id\n        firstName\n        lastName\n        emailAddress\n        phoneNumber\n        #[vatValidation|afas|parasut\n        customFields {\n          #[vatValidation\n          vatNumber\n          vatValidationStatus\n          #]\n          #[afas\n          afasVrId\n          afasOrgId\n          afasContactId\n          afasPersId\n          #]\n          #[parasut\n          parasutContactId\n          #]\n        }\n        #]\n        addresses {\n          id\n          fullName\n          company\n          streetLine1\n          streetLine2\n          city\n          postalCode\n          country {\n            code\n          }\n          defaultShippingAddress\n          defaultBillingAddress\n          #[afas\n          customFields {\n            afasAddressId\n          }\n          #]\n        }\n      }\n      lines {\n        id\n        quantity\n        unitPrice\n        unitPriceWithTax\n        listPriceIncludesTax\n        discountedUnitPrice\n        discountedUnitPriceWithTax\n        linePrice\n        linePriceWithTax\n        discountedLinePrice\n        discountedLinePriceWithTax\n        proratedLinePrice\n        proratedLinePriceWithTax\n        taxRate\n        productVariant {\n          id\n          name\n          sku\n          storePrice {\n            price\n            priceWithTax\n            currencyCode\n          }\n          stockOnHand\n          stockAllocated\n          trackInventory\n          outOfStockThreshold\n          useGlobalOutOfStockThreshold\n          stockLevels {\n            stockLocationId\n            stockOnHand\n            stockAllocated\n            stockLocation {\n              id\n              name\n            }\n          }\n          product {\n            id\n            name\n            featuredAsset {\n              id\n              preview\n            }\n          }\n        }\n        featuredAsset {\n          id\n          preview\n        }\n        #[lineAllocations\n        allocations {\n          id\n          stockLocation {\n            id\n            name\n          }\n          quantity\n        }\n        #]\n        outstandingAllocatedQuantity\n        outstandingAllocations {\n          stockLocationId\n          stockLocationName\n          quantity\n        }\n        customFields {\n          unitPriceOverride\n          priceOverrideReason\n          unitPriceImported\n          priceListId\n          priceListName\n          retailPrice\n          priceListPrice\n          priceListDiscountType\n          priceListDiscountValue\n          priceListDiscountChain\n          cost\n          preferredStockLocationId\n          backorderedQuantity\n        }\n      }\n      surcharges {\n        id\n        description\n        sku\n        price\n        priceWithTax\n        taxRate\n      }\n      discounts {\n        adjustmentSource\n        description\n        amount\n        amountWithTax\n      }\n      shippingLines {\n        shippingMethod {\n          id\n          name\n        }\n        discounts {\n          adjustmentSource\n          amount\n          amountWithTax\n        }\n      }\n      payments {\n        id\n        state\n        method\n        amount\n        transactionId\n        createdAt\n        refunds {\n          id\n          state\n          total\n          reason\n        }\n      }\n      fulfillments {\n        id\n        state\n        nextStates\n        method\n        trackingCode\n        lines {\n          orderLineId\n          quantity\n        }\n        #[fulfillmentDetails\n        handlerCode\n        handlerName\n        handlerDetails {\n          label\n          value\n        }\n        packingSlips {\n          id\n          packingSlipNumber\n          fulfillmentId\n          languageCode\n          storageKey\n          createdAt\n        }\n        #]\n        stockLocationName\n        linkedOrders {\n          id\n          code\n        }\n        customFields {\n          #[myparcel\n          myparcelShipmentId\n          myparcelLabelStatus\n          myparcelLabelFormat\n          myparcelLabelUrlA4\n          myparcelLabelUrlA6\n          myparcelLabelLastError\n          myparcelLabelHandoff\n          #]\n          bookingStatus\n        }\n        createdAt\n      }\n      shippingAddress {\n        fullName\n        company\n        streetLine1\n        streetLine2\n        city\n        province\n        postalCode\n        country\n        countryCode\n        phoneNumber\n      }\n      billingAddress {\n        fullName\n        company\n        streetLine1\n        streetLine2\n        city\n        province\n        postalCode\n        country\n        countryCode\n        phoneNumber\n      }\n      history(options: { take: 50, sort: { createdAt: DESC } }) {\n        items {\n          id\n          type\n          data\n          createdAt\n          isPublic\n          administrator {\n            id\n            firstName\n            lastName\n          }\n        }\n      }\n      taxSummary {\n        description\n        taxRate\n        taxBase\n        taxTotal\n      }\n      nextStates\n      createdAt\n      updatedAt\n      customFields {\n        isLocked\n        externalOrderId\n        externalPlatform\n        sourceFulfillmentHandedOff\n        originalPlacedAt\n        sourceWarehouse\n        pickupLocation\n        allocationExpiresAt\n        goodwillRoundingMinor\n        removeTax\n        isGift\n        giftNote\n        hidePricesOnPackingSlip\n        poNumber\n        requestedDeliveryDate\n        orderNotes\n        customerShippingAddressId\n        customerBillingAddressId\n        shippingAddressIsTemporary\n        billingAddressIsTemporary\n        paymentStatus\n        fulfillmentStatus\n        returnStatus\n        lifecycleStatus\n        #[paymentTerms\n        paymentTermsDays\n        paymentConditionCode\n        #]\n        #[afas\n        afasSalesOrderId\n        afasDirectInvoiceOrNu\n        afasInvoiceNumber\n        afasInvoiceDate\n        afasLocked\n        afasLockReason\n        afasLastSyncAt\n        #]\n        #[parasut\n        parasutInvoiceId\n        parasutEInvoiceStatus\n        parasutEInvoiceUuid\n        parasutLastError\n        #]\n      }\n      fulfillmentHold {\n        reason\n        note\n        heldAt\n        heldByUserId\n        heldBy\n      }\n      #[priceList\n      priceList {\n        id\n        name\n        description\n        defaultDiscountBps\n        defaultDiscountAmount\n        entries {\n          id\n          variantId\n          discountType\n          discountValue\n        }\n      }\n      #]\n    }\n  }\n";
 /**
  * The document `get` sends for a set of blocks: {@link ORDER_QUERY_EVERY_BLOCK}
  * without the blocks the call did not include, and without the marker lines.
@@ -714,6 +722,8 @@ export interface OrderGetModule {
      *
      * Why the order is the way it is (its lock, what may be done to it) is
      * {@link OrderStatusModule.status}, not a field here.
+     *
+     * @effect read
      */
     get(orderId: string): Promise<Order | null>;
     get<const O extends OrderGetOptions | undefined>(orderId: string, options: O): Promise<OrderGetAnswer<O> | null>;

package/dist/orders/get.js

@@ -9,12 +9,12 @@
  * in `include`, so a caller reads only what it uses, and the core document
  * names no field an engine without that plugin lacks.
  *
- * Money is an integer in minor units of the order's currency, with three
- * exceptions that are NOT converted to it: a line's `productVariant.price` and
- * `priceWithTax` (the catalogue price in the currency of the request, which is
- * the store's default unless the call names another), and a line's
- * `customFields.cost` (the store's default currency). An instant is an ISO-8601
- * string with its offset.
+ * Money is an integer in minor units of the order's currency, with two
+ * exceptions that are NOT converted to it: a line's `productVariant.storePrice`
+ * (the catalogue price in the currency of the request, which is the store's
+ * default unless the call names another; its own `currencyCode` says which),
+ * and a line's `customFields.cost` (the store's default currency). An instant is
+ * an ISO-8601 string with its offset.
  */
 import { ValidationError } from '@sixtyninecommerce/core';
 import { redactionWatcher } from '../customer-data-redaction.js';
@@ -210,8 +210,11 @@ export const ORDER_QUERY_EVERY_BLOCK = /* GraphQL */ `
           id
           name
           sku
-          price
-          priceWithTax
+          storePrice {
+            price
+            priceWithTax
+            currencyCode
+          }
           stockOnHand
           stockAllocated
           trackInventory
@@ -280,6 +283,7 @@ export const ORDER_QUERY_EVERY_BLOCK = /* GraphQL */ `
         taxRate
       }
       discounts {
+        adjustmentSource
         description
         amount
         amountWithTax
@@ -289,6 +293,11 @@ export const ORDER_QUERY_EVERY_BLOCK = /* GraphQL */ `
           id
           name
         }
+        discounts {
+          adjustmentSource
+          amount
+          amountWithTax
+        }
       }
       payments {
         id