@porulle/adapter-shopify 0.71.0 → 0.73.0

package/dist/index.d.ts

@@ -24,6 +24,9 @@ export declare const ORDER_CREATE_MUTATION = "mutation PorulleOrderCreate($order
  * took the payment, so it refunds and it writes to the shopper.
  */
 export declare const ORDER_CANCEL_MUTATION = "mutation PorulleOrderCancel($orderId: ID!, $reason: OrderCancelReason!, $staffNote: String) {\n  orderCancel(orderId: $orderId, reason: $reason, restock: true, notifyCustomer: false, staffNote: $staffNote) { orderCancelUserErrors { code message } }\n}";
+/** The order's shipped lines: a return names what it takes back by fulfilment line, not order line. */
+export declare const ORDER_FULFILLMENT_LINES_QUERY = "query PorulleOrderFulfillmentLines($id: ID!) {\n  order(id: $id) { fulfillments(first: 20) { fulfillmentLineItems(first: 50) { nodes { id quantity lineItem { variant { legacyResourceId } } } } } }\n}";
+export declare const RETURN_REQUEST_MUTATION = "mutation PorulleReturnRequest($input: ReturnRequestInput!) {\n  returnRequest(input: $input) { return { id } userErrors { code message } }\n}";
 export declare const ORDER_BY_SOURCE_QUERY = "query PorulleOrderBySource($query: String!) {\n  orders(first: 1, query: $query) { nodes { legacyResourceId } }\n}";
 export declare const ORDER_STATUS_QUERY = "query PorulleOrderStatus($id: ID!) {\n  order(id: $id) { cancelledAt displayFinancialStatus displayFulfillmentStatus }\n}";
 export declare function shopifyConnector(options: ShopifyConnectorOptions): ChannelConnector;

package/dist/index.js

@@ -26,6 +26,13 @@ export const ORDER_CREATE_MUTATION = `mutation PorulleOrderCreate($order: OrderC
 export const ORDER_CANCEL_MUTATION = `mutation PorulleOrderCancel($orderId: ID!, $reason: OrderCancelReason!, $staffNote: String) {
   orderCancel(orderId: $orderId, reason: $reason, restock: true, notifyCustomer: false, staffNote: $staffNote) { orderCancelUserErrors { code message } }
 }`;
+/** The order's shipped lines: a return names what it takes back by fulfilment line, not order line. */
+export const ORDER_FULFILLMENT_LINES_QUERY = `query PorulleOrderFulfillmentLines($id: ID!) {
+  order(id: $id) { fulfillments(first: 20) { fulfillmentLineItems(first: 50) { nodes { id quantity lineItem { variant { legacyResourceId } } } } } }
+}`;
+export const RETURN_REQUEST_MUTATION = `mutation PorulleReturnRequest($input: ReturnRequestInput!) {
+  returnRequest(input: $input) { return { id } userErrors { code message } }
+}`;
 export const ORDER_BY_SOURCE_QUERY = `query PorulleOrderBySource($query: String!) {
   orders(first: 1, query: $query) { nodes { legacyResourceId } }
 }`;
@@ -57,6 +64,16 @@ const CANCEL_REASON = {
     staff: "STAFF",
     other: "OTHER",
 };
+const fulfillmentLinesSchema = z.object({
+    order: z.object({
+        fulfillments: z.array(z.object({
+            fulfillmentLineItems: z.object({ nodes: z.array(z.object({ id: z.string(), quantity: z.number(), lineItem: z.object({ variant: z.object({ legacyResourceId: z.string() }).nullable() }) })) }),
+        })),
+    }).nullable(),
+});
+const returnRequestSchema = z.object({
+    returnRequest: z.object({ return: z.object({ id: z.string() }).nullable(), userErrors: z.array(z.object({ code: z.string().nullable(), message: z.string() })) }),
+});
 const orderBySourceSchema = z.object({ orders: z.object({ nodes: z.array(z.object({ legacyResourceId: z.string() })) }) });
 const orderStatusSchema = z.object({
     order: z.object({ cancelledAt: z.string().nullable(), displayFinancialStatus: z.string().nullable(), displayFulfillmentStatus: z.string() }).nullable(),
@@ -246,6 +263,8 @@ export function shopifyConnector(options) {
                     })),
                     // The delivery the shopper paid this seller, so the order total matches the payment below.
                     ...(slice.shipping ? { shippingLines: [{ title: slice.shipping.title, priceSet: money(slice.shipping.amount, slice.currency) }] } : {}),
+                    // The shopper's discount as a fixed amount off the items, so the store's total is what was paid.
+                    ...(slice.discount ? { discountCode: { itemFixedDiscountCode: { code: slice.discount.code, amountSet: money(slice.discount.amount, slice.currency) } } } : {}),
                     transactions: [{ kind: "SALE", status: "SUCCESS", gateway: SOURCE_NAME, amountSet: money(slice.grandTotal, slice.currency) }],
                 },
                 options: { inventoryBehaviour: "DECREMENT_OBEYING_POLICY", sendReceipt: false, sendFulfillmentReceipt: false },
@@ -293,6 +312,37 @@ export function shopifyConnector(options) {
                 return Ok(undefined);
             return Err({ code: CHANNEL_CANCEL_REFUSED, message: `Shopify refused to cancel the order: ${refusals.map((error) => error.message).join("; ")}.`, retriable: false });
         },
+        async requestReturn(store, remoteOrderId, input) {
+            const shop = target(store);
+            if (!shop)
+                return Err(credentialsRequired);
+            const shipped = await shopifyGraphql(shop, ORDER_FULFILLMENT_LINES_QUERY, { id: `gid://shopify/Order/${remoteOrderId}` }, fulfillmentLinesSchema);
+            if (!shipped.ok)
+                return shipped;
+            const fulfilmentLines = (shipped.value.order?.fulfillments ?? []).flatMap((fulfillment) => fulfillment.fulfillmentLineItems.nodes);
+            const returnLineItems = [];
+            const note = [input.reason, input.note].filter((part) => part !== undefined && part !== "").join(" — ").slice(0, 300);
+            for (const wanted of input.lines) {
+                let remaining = wanted.quantity;
+                for (const line of fulfilmentLines.filter((candidate) => candidate.lineItem.variant?.legacyResourceId === wanted.externalVariantId)) {
+                    if (remaining === 0)
+                        break;
+                    const take = Math.min(remaining, line.quantity);
+                    returnLineItems.push({ fulfillmentLineItemId: line.id, quantity: take, customerNote: note });
+                    remaining -= take;
+                }
+                if (remaining > 0)
+                    return Err({ code: "SHOPIFY_RETURN_NOT_SHIPPED", message: `Shopify has not shipped ${remaining} of variant ${wanted.externalVariantId}, so it cannot take them back.`, retriable: false });
+            }
+            const requested = await shopifyGraphql(shop, RETURN_REQUEST_MUTATION, { input: { orderId: `gid://shopify/Order/${remoteOrderId}`, returnLineItems } }, returnRequestSchema);
+            if (!requested.ok)
+                return requested;
+            const { return: created, userErrors } = requested.value.returnRequest;
+            if (userErrors.length > 0 || !created) {
+                return Err({ code: "SHOPIFY_RETURN_REFUSED", message: `Shopify refused the return: ${userErrors.map((error) => error.message).join("; ") || "no return created"}.`, retriable: false });
+            }
+            return Ok({ remoteReturnId: created.id.split("/").pop() ?? created.id });
+        },
         /**
          * Every Shopify delivery — catalogue, stock, orders, uninstall and the mandatory compliance topics —
          * arrives at ONE app-level address declared in `shopify.app.toml`, signed with the app's client