order.e2e-spec.ts 95 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539
  1. /* tslint:disable:no-non-null-assertion */
  2. import { omit } from '@vendure/common/lib/omit';
  3. import { pick } from '@vendure/common/lib/pick';
  4. import {
  5. defaultShippingCalculator,
  6. defaultShippingEligibilityChecker,
  7. manualFulfillmentHandler,
  8. mergeConfig,
  9. } from '@vendure/core';
  10. import {
  11. createErrorResultGuard,
  12. createTestEnvironment,
  13. ErrorResultGuard,
  14. SimpleGraphQLClient,
  15. } from '@vendure/testing';
  16. import gql from 'graphql-tag';
  17. import path from 'path';
  18. import { initialData } from '../../../e2e-common/e2e-initial-data';
  19. import { testConfig, TEST_SETUP_TIMEOUT_MS } from '../../../e2e-common/test-config';
  20. import {
  21. failsToSettlePaymentMethod,
  22. onTransitionSpy,
  23. partialPaymentMethod,
  24. singleStageRefundablePaymentMethod,
  25. singleStageRefundFailingPaymentMethod,
  26. twoStagePaymentMethod,
  27. } from './fixtures/test-payment-methods';
  28. import { FULFILLMENT_FRAGMENT } from './graphql/fragments';
  29. import {
  30. AddNoteToOrder,
  31. CanceledOrderFragment,
  32. CancelOrder,
  33. CreateFulfillment,
  34. CreateShippingMethod,
  35. DeleteOrderNote,
  36. DeleteProduct,
  37. DeleteShippingMethod,
  38. ErrorCode,
  39. FulfillmentFragment,
  40. GetCustomerList,
  41. GetOrder,
  42. GetOrderFulfillmentItems,
  43. GetOrderFulfillments,
  44. GetOrderHistory,
  45. GetOrderList,
  46. GetOrderListFulfillments,
  47. GetOrderListWithQty,
  48. GetOrderWithPayments,
  49. GetProductWithVariants,
  50. GetStockMovement,
  51. GlobalFlag,
  52. HistoryEntryType,
  53. LanguageCode,
  54. OrderLineInput,
  55. PaymentFragment,
  56. RefundFragment,
  57. RefundOrder,
  58. SettlePayment,
  59. SettleRefund,
  60. SortOrder,
  61. StockMovementType,
  62. TransitFulfillment,
  63. UpdateOrderNote,
  64. UpdateProductVariants,
  65. } from './graphql/generated-e2e-admin-types';
  66. import {
  67. AddItemToOrder,
  68. AddPaymentToOrder,
  69. ApplyCouponCode,
  70. DeletionResult,
  71. GetActiveCustomerOrderWithItemFulfillments,
  72. GetActiveCustomerWithOrdersProductPrice,
  73. GetActiveCustomerWithOrdersProductSlug,
  74. GetActiveOrder,
  75. GetOrderByCodeWithPayments,
  76. SetShippingAddress,
  77. SetShippingMethod,
  78. TestOrderFragmentFragment,
  79. UpdatedOrder,
  80. UpdatedOrderFragment,
  81. } from './graphql/generated-e2e-shop-types';
  82. import {
  83. CANCEL_ORDER,
  84. CREATE_FULFILLMENT,
  85. CREATE_SHIPPING_METHOD,
  86. DELETE_PRODUCT,
  87. DELETE_SHIPPING_METHOD,
  88. GET_CUSTOMER_LIST,
  89. GET_ORDER,
  90. GET_ORDERS_LIST,
  91. GET_ORDER_FULFILLMENTS,
  92. GET_ORDER_HISTORY,
  93. GET_PRODUCT_WITH_VARIANTS,
  94. GET_STOCK_MOVEMENT,
  95. SETTLE_PAYMENT,
  96. TRANSIT_FULFILLMENT,
  97. UPDATE_PRODUCT_VARIANTS,
  98. } from './graphql/shared-definitions';
  99. import {
  100. ADD_ITEM_TO_ORDER,
  101. ADD_PAYMENT,
  102. APPLY_COUPON_CODE,
  103. GET_ACTIVE_CUSTOMER_WITH_ORDERS_PRODUCT_PRICE,
  104. GET_ACTIVE_CUSTOMER_WITH_ORDERS_PRODUCT_SLUG,
  105. GET_ACTIVE_ORDER,
  106. GET_ACTIVE_ORDER_CUSTOMER_WITH_ITEM_FULFILLMENTS,
  107. GET_ORDER_BY_CODE_WITH_PAYMENTS,
  108. SET_SHIPPING_ADDRESS,
  109. SET_SHIPPING_METHOD,
  110. } from './graphql/shop-definitions';
  111. import { assertThrowsWithMessage } from './utils/assert-throws-with-message';
  112. import { addPaymentToOrder, proceedToArrangingPayment, sortById } from './utils/test-order-utils';
  113. describe('Orders resolver', () => {
  114. const { server, adminClient, shopClient } = createTestEnvironment(
  115. mergeConfig(testConfig(), {
  116. paymentOptions: {
  117. paymentMethodHandlers: [
  118. twoStagePaymentMethod,
  119. failsToSettlePaymentMethod,
  120. singleStageRefundablePaymentMethod,
  121. partialPaymentMethod,
  122. singleStageRefundFailingPaymentMethod,
  123. ],
  124. },
  125. }),
  126. );
  127. let customers: GetCustomerList.Items[];
  128. const password = 'test';
  129. const orderGuard: ErrorResultGuard<
  130. TestOrderFragmentFragment | CanceledOrderFragment | UpdatedOrderFragment
  131. > = createErrorResultGuard(input => !!input.lines);
  132. const paymentGuard: ErrorResultGuard<PaymentFragment> = createErrorResultGuard(input => !!input.state);
  133. const fulfillmentGuard: ErrorResultGuard<FulfillmentFragment> = createErrorResultGuard(
  134. input => !!input.method,
  135. );
  136. const refundGuard: ErrorResultGuard<RefundFragment> = createErrorResultGuard(input => !!input.items);
  137. beforeAll(async () => {
  138. await server.init({
  139. initialData: {
  140. ...initialData,
  141. paymentMethods: [
  142. {
  143. name: twoStagePaymentMethod.code,
  144. handler: { code: twoStagePaymentMethod.code, arguments: [] },
  145. },
  146. {
  147. name: failsToSettlePaymentMethod.code,
  148. handler: { code: failsToSettlePaymentMethod.code, arguments: [] },
  149. },
  150. {
  151. name: singleStageRefundablePaymentMethod.code,
  152. handler: { code: singleStageRefundablePaymentMethod.code, arguments: [] },
  153. },
  154. {
  155. name: singleStageRefundFailingPaymentMethod.code,
  156. handler: { code: singleStageRefundFailingPaymentMethod.code, arguments: [] },
  157. },
  158. {
  159. name: partialPaymentMethod.code,
  160. handler: { code: partialPaymentMethod.code, arguments: [] },
  161. },
  162. ],
  163. },
  164. productsCsvPath: path.join(__dirname, 'fixtures/e2e-products-full.csv'),
  165. customerCount: 3,
  166. });
  167. await adminClient.asSuperAdmin();
  168. // Create a couple of orders to be queried
  169. const result = await adminClient.query<GetCustomerList.Query, GetCustomerList.Variables>(
  170. GET_CUSTOMER_LIST,
  171. {
  172. options: {
  173. take: 3,
  174. },
  175. },
  176. );
  177. customers = result.customers.items;
  178. await shopClient.asUserWithCredentials(customers[0].emailAddress, password);
  179. await shopClient.query<AddItemToOrder.Mutation, AddItemToOrder.Variables>(ADD_ITEM_TO_ORDER, {
  180. productVariantId: 'T_1',
  181. quantity: 1,
  182. });
  183. await shopClient.query<AddItemToOrder.Mutation, AddItemToOrder.Variables>(ADD_ITEM_TO_ORDER, {
  184. productVariantId: 'T_2',
  185. quantity: 1,
  186. });
  187. await shopClient.asUserWithCredentials(customers[1].emailAddress, password);
  188. await shopClient.query<AddItemToOrder.Mutation, AddItemToOrder.Variables>(ADD_ITEM_TO_ORDER, {
  189. productVariantId: 'T_2',
  190. quantity: 1,
  191. });
  192. await shopClient.query<AddItemToOrder.Mutation, AddItemToOrder.Variables>(ADD_ITEM_TO_ORDER, {
  193. productVariantId: 'T_3',
  194. quantity: 3,
  195. });
  196. }, TEST_SETUP_TIMEOUT_MS);
  197. afterAll(async () => {
  198. await server.destroy();
  199. });
  200. it('order history initially contains Created -> AddingItems transition', async () => {
  201. const { order } = await adminClient.query<GetOrderHistory.Query, GetOrderHistory.Variables>(
  202. GET_ORDER_HISTORY,
  203. { id: 'T_1' },
  204. );
  205. expect(order!.history.totalItems).toBe(1);
  206. expect(order!.history.items.map(pick(['type', 'data']))).toEqual([
  207. {
  208. type: HistoryEntryType.ORDER_STATE_TRANSITION,
  209. data: {
  210. from: 'Created',
  211. to: 'AddingItems',
  212. },
  213. },
  214. ]);
  215. });
  216. describe('querying', () => {
  217. it('orders', async () => {
  218. const result = await adminClient.query<GetOrderList.Query>(GET_ORDERS_LIST);
  219. expect(result.orders.items.map(o => o.id).sort()).toEqual(['T_1', 'T_2']);
  220. });
  221. it('order', async () => {
  222. const result = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
  223. id: 'T_2',
  224. });
  225. expect(result.order!.id).toBe('T_2');
  226. });
  227. it('order with calculated line properties', async () => {
  228. const result = await adminClient.query<GetOrder.Query, GetOrder.Variables>(
  229. gql`
  230. query GetOrderWithLineCalculatedProps($id: ID!) {
  231. order(id: $id) {
  232. id
  233. lines {
  234. id
  235. linePriceWithTax
  236. quantity
  237. }
  238. }
  239. }
  240. `,
  241. {
  242. id: 'T_2',
  243. },
  244. );
  245. expect(result.order!.lines).toEqual([
  246. {
  247. id: 'T_3',
  248. linePriceWithTax: 167880,
  249. quantity: 1,
  250. },
  251. {
  252. id: 'T_4',
  253. linePriceWithTax: 791640,
  254. quantity: 3,
  255. },
  256. ]);
  257. });
  258. it('sort by total', async () => {
  259. const result = await adminClient.query<GetOrderList.Query, GetOrderList.Variables>(
  260. GET_ORDERS_LIST,
  261. {
  262. options: {
  263. sort: {
  264. total: SortOrder.DESC,
  265. },
  266. take: 10,
  267. },
  268. },
  269. );
  270. expect(result.orders.items.map(o => pick(o, ['id', 'total']))).toEqual([
  271. { id: 'T_2', total: 799600 },
  272. { id: 'T_1', total: 269800 },
  273. ]);
  274. });
  275. it('sort by totalWithTax', async () => {
  276. const result = await adminClient.query<GetOrderList.Query, GetOrderList.Variables>(
  277. GET_ORDERS_LIST,
  278. {
  279. options: {
  280. sort: {
  281. totalWithTax: SortOrder.DESC,
  282. },
  283. take: 10,
  284. },
  285. },
  286. );
  287. expect(result.orders.items.map(o => pick(o, ['id', 'totalWithTax']))).toEqual([
  288. { id: 'T_2', totalWithTax: 959520 },
  289. { id: 'T_1', totalWithTax: 323760 },
  290. ]);
  291. });
  292. it('sort by totalQuantity', async () => {
  293. const result = await adminClient.query<GetOrderList.Query, GetOrderList.Variables>(
  294. GET_ORDERS_LIST,
  295. {
  296. options: {
  297. sort: {
  298. totalQuantity: SortOrder.DESC,
  299. },
  300. take: 10,
  301. },
  302. },
  303. );
  304. expect(result.orders.items.map(o => pick(o, ['id', 'totalQuantity']))).toEqual([
  305. { id: 'T_2', totalQuantity: 4 },
  306. { id: 'T_1', totalQuantity: 2 },
  307. ]);
  308. });
  309. it('sort by customerLastName', async () => {
  310. async function sortOrdersByLastName(sortOrder: SortOrder) {
  311. const { orders } = await adminClient.query<GetOrderList.Query, GetOrderList.Variables>(
  312. GET_ORDERS_LIST,
  313. {
  314. options: {
  315. sort: {
  316. customerLastName: sortOrder,
  317. },
  318. },
  319. },
  320. );
  321. return orders;
  322. }
  323. const result1 = await sortOrdersByLastName(SortOrder.ASC);
  324. expect(result1.totalItems).toEqual(2);
  325. expect(result1.items.map(order => order.customer?.lastName)).toEqual(['Donnelly', 'Zieme']);
  326. const result2 = await sortOrdersByLastName(SortOrder.DESC);
  327. expect(result2.totalItems).toEqual(2);
  328. expect(result2.items.map(order => order.customer?.lastName)).toEqual(['Zieme', 'Donnelly']);
  329. });
  330. it('filter by total', async () => {
  331. const result = await adminClient.query<GetOrderList.Query, GetOrderList.Variables>(
  332. GET_ORDERS_LIST,
  333. {
  334. options: {
  335. filter: {
  336. total: { gt: 323760 },
  337. },
  338. take: 10,
  339. },
  340. },
  341. );
  342. expect(result.orders.items.map(o => pick(o, ['id', 'total']))).toEqual([
  343. { id: 'T_2', total: 799600 },
  344. ]);
  345. });
  346. it('filter by totalWithTax', async () => {
  347. const result = await adminClient.query<GetOrderList.Query, GetOrderList.Variables>(
  348. GET_ORDERS_LIST,
  349. {
  350. options: {
  351. filter: {
  352. totalWithTax: { gt: 323760 },
  353. },
  354. take: 10,
  355. },
  356. },
  357. );
  358. expect(result.orders.items.map(o => pick(o, ['id', 'totalWithTax']))).toEqual([
  359. { id: 'T_2', totalWithTax: 959520 },
  360. ]);
  361. });
  362. it('filter by totalQuantity', async () => {
  363. const result = await adminClient.query<GetOrderList.Query, GetOrderList.Variables>(
  364. GET_ORDERS_LIST,
  365. {
  366. options: {
  367. filter: {
  368. totalQuantity: { eq: 4 },
  369. },
  370. },
  371. },
  372. );
  373. expect(result.orders.items.map(o => pick(o, ['id', 'totalQuantity']))).toEqual([
  374. { id: 'T_2', totalQuantity: 4 },
  375. ]);
  376. });
  377. it('filter by customerLastName', async () => {
  378. const result = await adminClient.query<GetOrderList.Query, GetOrderList.Variables>(
  379. GET_ORDERS_LIST,
  380. {
  381. options: {
  382. filter: {
  383. customerLastName: {
  384. eq: customers[1].lastName,
  385. },
  386. },
  387. },
  388. },
  389. );
  390. expect(result.orders.totalItems).toEqual(1);
  391. expect(result.orders.items[0].customer?.lastName).toEqual(customers[1].lastName);
  392. });
  393. });
  394. describe('payments', () => {
  395. let firstOrderCode: string;
  396. let firstOrderId: string;
  397. it('settlePayment fails', async () => {
  398. await shopClient.asUserWithCredentials(customers[0].emailAddress, password);
  399. await proceedToArrangingPayment(shopClient);
  400. const order = await addPaymentToOrder(shopClient, failsToSettlePaymentMethod);
  401. orderGuard.assertSuccess(order);
  402. expect(order.state).toBe('PaymentAuthorized');
  403. const payment = order.payments![0];
  404. const { settlePayment } = await adminClient.query<
  405. SettlePayment.Mutation,
  406. SettlePayment.Variables
  407. >(SETTLE_PAYMENT, {
  408. id: payment.id,
  409. });
  410. paymentGuard.assertErrorResult(settlePayment);
  411. expect(settlePayment.message).toBe('Settling the payment failed');
  412. expect(settlePayment.errorCode).toBe(ErrorCode.SETTLE_PAYMENT_ERROR);
  413. expect((settlePayment as any).paymentErrorMessage).toBe('Something went horribly wrong');
  414. const result = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
  415. id: order.id,
  416. });
  417. expect(result.order!.state).toBe('PaymentAuthorized');
  418. expect(result.order!.payments![0].state).toBe('Cancelled');
  419. firstOrderCode = order.code;
  420. firstOrderId = order.id;
  421. });
  422. it('public payment metadata available in Shop API', async () => {
  423. const { orderByCode } = await shopClient.query<
  424. GetOrderByCodeWithPayments.Query,
  425. GetOrderByCodeWithPayments.Variables
  426. >(GET_ORDER_BY_CODE_WITH_PAYMENTS, { code: firstOrderCode });
  427. expect(orderByCode?.payments?.[0].metadata).toEqual({
  428. public: {
  429. publicCreatePaymentData: 'public',
  430. publicSettlePaymentData: 'public',
  431. },
  432. });
  433. });
  434. it('public and private payment metadata available in Admin API', async () => {
  435. const { order } = await adminClient.query<
  436. GetOrderWithPayments.Query,
  437. GetOrderWithPayments.Variables
  438. >(GET_ORDER_WITH_PAYMENTS, { id: firstOrderId });
  439. expect(order?.payments?.[0].metadata).toEqual({
  440. privateCreatePaymentData: 'secret',
  441. privateSettlePaymentData: 'secret',
  442. public: {
  443. publicCreatePaymentData: 'public',
  444. publicSettlePaymentData: 'public',
  445. },
  446. });
  447. });
  448. it('settlePayment succeeds, onStateTransitionStart called', async () => {
  449. onTransitionSpy.mockClear();
  450. await shopClient.asUserWithCredentials(customers[1].emailAddress, password);
  451. await proceedToArrangingPayment(shopClient);
  452. const order = await addPaymentToOrder(shopClient, twoStagePaymentMethod);
  453. orderGuard.assertSuccess(order);
  454. expect(order.state).toBe('PaymentAuthorized');
  455. expect(onTransitionSpy).toHaveBeenCalledTimes(1);
  456. expect(onTransitionSpy.mock.calls[0][0]).toBe('Created');
  457. expect(onTransitionSpy.mock.calls[0][1]).toBe('Authorized');
  458. const payment = order.payments![0];
  459. const { settlePayment } = await adminClient.query<
  460. SettlePayment.Mutation,
  461. SettlePayment.Variables
  462. >(SETTLE_PAYMENT, {
  463. id: payment.id,
  464. });
  465. paymentGuard.assertSuccess(settlePayment);
  466. expect(settlePayment!.id).toBe(payment.id);
  467. expect(settlePayment!.state).toBe('Settled');
  468. // further metadata is combined into existing object
  469. expect(settlePayment!.metadata).toEqual({
  470. moreData: 42,
  471. public: {
  472. baz: 'quux',
  473. },
  474. });
  475. expect(onTransitionSpy).toHaveBeenCalledTimes(2);
  476. expect(onTransitionSpy.mock.calls[1][0]).toBe('Authorized');
  477. expect(onTransitionSpy.mock.calls[1][1]).toBe('Settled');
  478. const result = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
  479. id: order.id,
  480. });
  481. expect(result.order!.state).toBe('PaymentSettled');
  482. expect(result.order!.payments![0].state).toBe('Settled');
  483. });
  484. it('order history contains expected entries', async () => {
  485. const { order } = await adminClient.query<GetOrderHistory.Query, GetOrderHistory.Variables>(
  486. GET_ORDER_HISTORY,
  487. { id: 'T_2', options: { sort: { id: SortOrder.ASC } } },
  488. );
  489. expect(order!.history.items.map(pick(['type', 'data']))).toEqual([
  490. {
  491. type: HistoryEntryType.ORDER_STATE_TRANSITION,
  492. data: {
  493. from: 'Created',
  494. to: 'AddingItems',
  495. },
  496. },
  497. {
  498. type: HistoryEntryType.ORDER_STATE_TRANSITION,
  499. data: {
  500. from: 'AddingItems',
  501. to: 'ArrangingPayment',
  502. },
  503. },
  504. {
  505. type: HistoryEntryType.ORDER_PAYMENT_TRANSITION,
  506. data: {
  507. paymentId: 'T_2',
  508. from: 'Created',
  509. to: 'Authorized',
  510. },
  511. },
  512. {
  513. type: HistoryEntryType.ORDER_STATE_TRANSITION,
  514. data: {
  515. from: 'ArrangingPayment',
  516. to: 'PaymentAuthorized',
  517. },
  518. },
  519. {
  520. type: HistoryEntryType.ORDER_PAYMENT_TRANSITION,
  521. data: {
  522. paymentId: 'T_2',
  523. from: 'Authorized',
  524. to: 'Settled',
  525. },
  526. },
  527. {
  528. type: HistoryEntryType.ORDER_STATE_TRANSITION,
  529. data: {
  530. from: 'PaymentAuthorized',
  531. to: 'PaymentSettled',
  532. },
  533. },
  534. ]);
  535. });
  536. });
  537. describe('fulfillment', () => {
  538. const orderId = 'T_2';
  539. let f1Id: string;
  540. let f2Id: string;
  541. let f3Id: string;
  542. it('return error result if lines is empty', async () => {
  543. const { order } = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
  544. id: orderId,
  545. });
  546. expect(order!.state).toBe('PaymentSettled');
  547. const { addFulfillmentToOrder } = await adminClient.query<
  548. CreateFulfillment.Mutation,
  549. CreateFulfillment.Variables
  550. >(CREATE_FULFILLMENT, {
  551. input: {
  552. lines: [],
  553. handler: {
  554. code: manualFulfillmentHandler.code,
  555. arguments: [{ name: 'method', value: 'Test' }],
  556. },
  557. },
  558. });
  559. fulfillmentGuard.assertErrorResult(addFulfillmentToOrder);
  560. expect(addFulfillmentToOrder.message).toBe('At least one OrderLine must be specified');
  561. expect(addFulfillmentToOrder.errorCode).toBe(ErrorCode.EMPTY_ORDER_LINE_SELECTION_ERROR);
  562. });
  563. it('returns error result if all quantities are zero', async () => {
  564. const { order } = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
  565. id: orderId,
  566. });
  567. expect(order!.state).toBe('PaymentSettled');
  568. const { addFulfillmentToOrder } = await adminClient.query<
  569. CreateFulfillment.Mutation,
  570. CreateFulfillment.Variables
  571. >(CREATE_FULFILLMENT, {
  572. input: {
  573. lines: order!.lines.map(l => ({ orderLineId: l.id, quantity: 0 })),
  574. handler: {
  575. code: manualFulfillmentHandler.code,
  576. arguments: [{ name: 'method', value: 'Test' }],
  577. },
  578. },
  579. });
  580. fulfillmentGuard.assertErrorResult(addFulfillmentToOrder);
  581. expect(addFulfillmentToOrder.message).toBe('At least one OrderLine must be specified');
  582. expect(addFulfillmentToOrder.errorCode).toBe(ErrorCode.EMPTY_ORDER_LINE_SELECTION_ERROR);
  583. });
  584. it('creates the first fulfillment', async () => {
  585. const { order } = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
  586. id: orderId,
  587. });
  588. expect(order!.state).toBe('PaymentSettled');
  589. const lines = order!.lines;
  590. const { addFulfillmentToOrder } = await adminClient.query<
  591. CreateFulfillment.Mutation,
  592. CreateFulfillment.Variables
  593. >(CREATE_FULFILLMENT, {
  594. input: {
  595. lines: [{ orderLineId: lines[0].id, quantity: lines[0].quantity }],
  596. handler: {
  597. code: manualFulfillmentHandler.code,
  598. arguments: [
  599. { name: 'method', value: 'Test1' },
  600. { name: 'trackingCode', value: '111' },
  601. ],
  602. },
  603. },
  604. });
  605. fulfillmentGuard.assertSuccess(addFulfillmentToOrder);
  606. expect(addFulfillmentToOrder.id).toBe('T_1');
  607. expect(addFulfillmentToOrder.method).toBe('Test1');
  608. expect(addFulfillmentToOrder.trackingCode).toBe('111');
  609. expect(addFulfillmentToOrder.state).toBe('Pending');
  610. expect(addFulfillmentToOrder.orderItems).toEqual([{ id: lines[0].items[0].id }]);
  611. f1Id = addFulfillmentToOrder.id;
  612. const result = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
  613. id: orderId,
  614. });
  615. expect(result.order!.lines[0].items[0].fulfillment!.id).toBe(addFulfillmentToOrder!.id);
  616. expect(
  617. result.order!.lines[1].items.filter(
  618. i => i.fulfillment && i.fulfillment.id === addFulfillmentToOrder.id,
  619. ).length,
  620. ).toBe(0);
  621. expect(result.order!.lines[1].items.filter(i => i.fulfillment == null).length).toBe(3);
  622. });
  623. it('creates the second fulfillment', async () => {
  624. const lines = await getUnfulfilledOrderLineInput(adminClient, orderId);
  625. const { addFulfillmentToOrder } = await adminClient.query<
  626. CreateFulfillment.Mutation,
  627. CreateFulfillment.Variables
  628. >(CREATE_FULFILLMENT, {
  629. input: {
  630. lines,
  631. handler: {
  632. code: manualFulfillmentHandler.code,
  633. arguments: [
  634. { name: 'method', value: 'Test2' },
  635. { name: 'trackingCode', value: '222' },
  636. ],
  637. },
  638. },
  639. });
  640. fulfillmentGuard.assertSuccess(addFulfillmentToOrder);
  641. expect(addFulfillmentToOrder.id).toBe('T_2');
  642. expect(addFulfillmentToOrder.method).toBe('Test2');
  643. expect(addFulfillmentToOrder.trackingCode).toBe('222');
  644. expect(addFulfillmentToOrder.state).toBe('Pending');
  645. f2Id = addFulfillmentToOrder.id;
  646. });
  647. it('cancels second fulfillment', async () => {
  648. const { transitionFulfillmentToState } = await adminClient.query<
  649. TransitFulfillment.Mutation,
  650. TransitFulfillment.Variables
  651. >(TRANSIT_FULFILLMENT, {
  652. id: f2Id,
  653. state: 'Cancelled',
  654. });
  655. fulfillmentGuard.assertSuccess(transitionFulfillmentToState);
  656. expect(transitionFulfillmentToState.id).toBe('T_2');
  657. expect(transitionFulfillmentToState.state).toBe('Cancelled');
  658. });
  659. it('order.fulfillments still lists second (cancelled) fulfillment', async () => {
  660. const { order } = await adminClient.query<
  661. GetOrderFulfillments.Query,
  662. GetOrderFulfillments.Variables
  663. >(GET_ORDER_FULFILLMENTS, {
  664. id: orderId,
  665. });
  666. expect(order?.fulfillments?.map(pick(['id', 'state']))).toEqual([
  667. { id: f1Id, state: 'Pending' },
  668. { id: f2Id, state: 'Cancelled' },
  669. ]);
  670. });
  671. it('creates third fulfillment with same items from second fulfillment', async () => {
  672. const lines = await getUnfulfilledOrderLineInput(adminClient, orderId);
  673. const { addFulfillmentToOrder } = await adminClient.query<
  674. CreateFulfillment.Mutation,
  675. CreateFulfillment.Variables
  676. >(CREATE_FULFILLMENT, {
  677. input: {
  678. lines,
  679. handler: {
  680. code: manualFulfillmentHandler.code,
  681. arguments: [
  682. { name: 'method', value: 'Test3' },
  683. { name: 'trackingCode', value: '333' },
  684. ],
  685. },
  686. },
  687. });
  688. fulfillmentGuard.assertSuccess(addFulfillmentToOrder);
  689. expect(addFulfillmentToOrder.id).toBe('T_3');
  690. expect(addFulfillmentToOrder.method).toBe('Test3');
  691. expect(addFulfillmentToOrder.trackingCode).toBe('333');
  692. expect(addFulfillmentToOrder.state).toBe('Pending');
  693. f3Id = addFulfillmentToOrder.id;
  694. });
  695. it('returns error result if an OrderItem already part of a Fulfillment', async () => {
  696. const { order } = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
  697. id: orderId,
  698. });
  699. const { addFulfillmentToOrder } = await adminClient.query<
  700. CreateFulfillment.Mutation,
  701. CreateFulfillment.Variables
  702. >(CREATE_FULFILLMENT, {
  703. input: {
  704. lines: [
  705. {
  706. orderLineId: order!.lines[0].id,
  707. quantity: 1,
  708. },
  709. ],
  710. handler: {
  711. code: manualFulfillmentHandler.code,
  712. arguments: [{ name: 'method', value: 'Test' }],
  713. },
  714. },
  715. });
  716. fulfillmentGuard.assertErrorResult(addFulfillmentToOrder);
  717. expect(addFulfillmentToOrder.message).toBe(
  718. 'One or more OrderItems are already part of a Fulfillment',
  719. );
  720. expect(addFulfillmentToOrder.errorCode).toBe(ErrorCode.ITEMS_ALREADY_FULFILLED_ERROR);
  721. });
  722. it('transitions the first fulfillment from created to Shipped and automatically change the order state to PartiallyShipped', async () => {
  723. const { transitionFulfillmentToState } = await adminClient.query<
  724. TransitFulfillment.Mutation,
  725. TransitFulfillment.Variables
  726. >(TRANSIT_FULFILLMENT, {
  727. id: f1Id,
  728. state: 'Shipped',
  729. });
  730. fulfillmentGuard.assertSuccess(transitionFulfillmentToState);
  731. expect(transitionFulfillmentToState.id).toBe(f1Id);
  732. expect(transitionFulfillmentToState.state).toBe('Shipped');
  733. const { order } = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
  734. id: orderId,
  735. });
  736. expect(order?.state).toBe('PartiallyShipped');
  737. });
  738. it('transitions the third fulfillment from created to Shipped and automatically change the order state to Shipped', async () => {
  739. const { transitionFulfillmentToState } = await adminClient.query<
  740. TransitFulfillment.Mutation,
  741. TransitFulfillment.Variables
  742. >(TRANSIT_FULFILLMENT, {
  743. id: f3Id,
  744. state: 'Shipped',
  745. });
  746. fulfillmentGuard.assertSuccess(transitionFulfillmentToState);
  747. expect(transitionFulfillmentToState.id).toBe(f3Id);
  748. expect(transitionFulfillmentToState.state).toBe('Shipped');
  749. const { order } = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
  750. id: orderId,
  751. });
  752. expect(order?.state).toBe('Shipped');
  753. });
  754. it('transitions the first fulfillment from Shipped to Delivered and change the order state to PartiallyDelivered', async () => {
  755. const { transitionFulfillmentToState } = await adminClient.query<
  756. TransitFulfillment.Mutation,
  757. TransitFulfillment.Variables
  758. >(TRANSIT_FULFILLMENT, {
  759. id: f1Id,
  760. state: 'Delivered',
  761. });
  762. fulfillmentGuard.assertSuccess(transitionFulfillmentToState);
  763. expect(transitionFulfillmentToState.id).toBe(f1Id);
  764. expect(transitionFulfillmentToState.state).toBe('Delivered');
  765. const { order } = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
  766. id: orderId,
  767. });
  768. expect(order?.state).toBe('PartiallyDelivered');
  769. });
  770. it('transitions the third fulfillment from Shipped to Delivered and change the order state to Delivered', async () => {
  771. const { transitionFulfillmentToState } = await adminClient.query<
  772. TransitFulfillment.Mutation,
  773. TransitFulfillment.Variables
  774. >(TRANSIT_FULFILLMENT, {
  775. id: f3Id,
  776. state: 'Delivered',
  777. });
  778. fulfillmentGuard.assertSuccess(transitionFulfillmentToState);
  779. expect(transitionFulfillmentToState.id).toBe(f3Id);
  780. expect(transitionFulfillmentToState.state).toBe('Delivered');
  781. const { order } = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
  782. id: orderId,
  783. });
  784. expect(order?.state).toBe('Delivered');
  785. });
  786. it('order history contains expected entries', async () => {
  787. const { order } = await adminClient.query<GetOrderHistory.Query, GetOrderHistory.Variables>(
  788. GET_ORDER_HISTORY,
  789. {
  790. id: orderId,
  791. options: {
  792. skip: 6,
  793. },
  794. },
  795. );
  796. expect(order!.history.items.map(pick(['type', 'data']))).toEqual([
  797. {
  798. data: {
  799. fulfillmentId: f1Id,
  800. },
  801. type: HistoryEntryType.ORDER_FULFILLMENT,
  802. },
  803. {
  804. data: {
  805. from: 'Created',
  806. fulfillmentId: f1Id,
  807. to: 'Pending',
  808. },
  809. type: HistoryEntryType.ORDER_FULFILLMENT_TRANSITION,
  810. },
  811. {
  812. data: {
  813. fulfillmentId: f2Id,
  814. },
  815. type: HistoryEntryType.ORDER_FULFILLMENT,
  816. },
  817. {
  818. data: {
  819. from: 'Created',
  820. fulfillmentId: f2Id,
  821. to: 'Pending',
  822. },
  823. type: HistoryEntryType.ORDER_FULFILLMENT_TRANSITION,
  824. },
  825. {
  826. data: {
  827. from: 'Pending',
  828. fulfillmentId: f2Id,
  829. to: 'Cancelled',
  830. },
  831. type: HistoryEntryType.ORDER_FULFILLMENT_TRANSITION,
  832. },
  833. {
  834. data: {
  835. fulfillmentId: f3Id,
  836. },
  837. type: HistoryEntryType.ORDER_FULFILLMENT,
  838. },
  839. {
  840. data: {
  841. from: 'Created',
  842. fulfillmentId: f3Id,
  843. to: 'Pending',
  844. },
  845. type: HistoryEntryType.ORDER_FULFILLMENT_TRANSITION,
  846. },
  847. {
  848. data: {
  849. from: 'Pending',
  850. fulfillmentId: f1Id,
  851. to: 'Shipped',
  852. },
  853. type: HistoryEntryType.ORDER_FULFILLMENT_TRANSITION,
  854. },
  855. {
  856. data: {
  857. from: 'PaymentSettled',
  858. to: 'PartiallyShipped',
  859. },
  860. type: HistoryEntryType.ORDER_STATE_TRANSITION,
  861. },
  862. {
  863. data: {
  864. from: 'Pending',
  865. fulfillmentId: f3Id,
  866. to: 'Shipped',
  867. },
  868. type: HistoryEntryType.ORDER_FULFILLMENT_TRANSITION,
  869. },
  870. {
  871. data: {
  872. from: 'PartiallyShipped',
  873. to: 'Shipped',
  874. },
  875. type: HistoryEntryType.ORDER_STATE_TRANSITION,
  876. },
  877. {
  878. data: {
  879. from: 'Shipped',
  880. fulfillmentId: f1Id,
  881. to: 'Delivered',
  882. },
  883. type: HistoryEntryType.ORDER_FULFILLMENT_TRANSITION,
  884. },
  885. {
  886. data: {
  887. from: 'Shipped',
  888. to: 'PartiallyDelivered',
  889. },
  890. type: HistoryEntryType.ORDER_STATE_TRANSITION,
  891. },
  892. {
  893. data: {
  894. from: 'Shipped',
  895. fulfillmentId: f3Id,
  896. to: 'Delivered',
  897. },
  898. type: HistoryEntryType.ORDER_FULFILLMENT_TRANSITION,
  899. },
  900. {
  901. data: {
  902. from: 'PartiallyDelivered',
  903. to: 'Delivered',
  904. },
  905. type: HistoryEntryType.ORDER_STATE_TRANSITION,
  906. },
  907. ]);
  908. });
  909. it('order.fulfillments resolver for single order', async () => {
  910. const { order } = await adminClient.query<
  911. GetOrderFulfillments.Query,
  912. GetOrderFulfillments.Variables
  913. >(GET_ORDER_FULFILLMENTS, {
  914. id: orderId,
  915. });
  916. expect(order!.fulfillments?.sort(sortById)).toEqual([
  917. { id: f1Id, method: 'Test1', state: 'Delivered', nextStates: ['Cancelled'] },
  918. { id: f2Id, method: 'Test2', state: 'Cancelled', nextStates: [] },
  919. { id: f3Id, method: 'Test3', state: 'Delivered', nextStates: ['Cancelled'] },
  920. ]);
  921. });
  922. it('order.fulfillments resolver for order list', async () => {
  923. const { orders } = await adminClient.query<GetOrderListFulfillments.Query>(
  924. GET_ORDER_LIST_FULFILLMENTS,
  925. );
  926. expect(orders.items[0].fulfillments).toEqual([]);
  927. expect(orders.items[1].fulfillments).toEqual([
  928. { id: f1Id, method: 'Test1', state: 'Delivered', nextStates: ['Cancelled'] },
  929. { id: f2Id, method: 'Test2', state: 'Cancelled', nextStates: [] },
  930. { id: f3Id, method: 'Test3', state: 'Delivered', nextStates: ['Cancelled'] },
  931. ]);
  932. });
  933. it('order.fulfillments.orderItems resolver', async () => {
  934. const { order } = await adminClient.query<
  935. GetOrderFulfillmentItems.Query,
  936. GetOrderFulfillmentItems.Variables
  937. >(GET_ORDER_FULFILLMENT_ITEMS, {
  938. id: orderId,
  939. });
  940. expect(order!.fulfillments![0].orderItems).toEqual([{ id: 'T_3' }]);
  941. expect(order!.fulfillments![1].orderItems).toEqual([{ id: 'T_4' }, { id: 'T_5' }, { id: 'T_6' }]);
  942. expect(order!.fulfillments![2].orderItems).toEqual([{ id: 'T_4' }, { id: 'T_5' }, { id: 'T_6' }]);
  943. });
  944. it('order.line.items.fulfillment resolver', async () => {
  945. const { order } = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
  946. id: orderId,
  947. });
  948. const { activeCustomer } = await shopClient.query<
  949. GetActiveCustomerOrderWithItemFulfillments.Query,
  950. GetActiveCustomerOrderWithItemFulfillments.Variables
  951. >(GET_ACTIVE_ORDER_CUSTOMER_WITH_ITEM_FULFILLMENTS);
  952. const firstCustomerOrder = activeCustomer!.orders.items[0]!;
  953. expect(firstCustomerOrder.lines[0].items[0].fulfillment).not.toBeNull();
  954. });
  955. });
  956. describe('cancellation by orderId', () => {
  957. it('cancel from AddingItems state', async () => {
  958. const testOrder = await createTestOrder(
  959. adminClient,
  960. shopClient,
  961. customers[0].emailAddress,
  962. password,
  963. );
  964. const { order } = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
  965. id: testOrder.orderId,
  966. });
  967. expect(order!.state).toBe('AddingItems');
  968. const { cancelOrder } = await adminClient.query<CancelOrder.Mutation, CancelOrder.Variables>(
  969. CANCEL_ORDER,
  970. {
  971. input: {
  972. orderId: testOrder.orderId,
  973. },
  974. },
  975. );
  976. const { order: order2 } = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
  977. id: testOrder.orderId,
  978. });
  979. expect(order2!.state).toBe('Cancelled');
  980. expect(order2!.active).toBe(false);
  981. await assertNoStockMovementsCreated(testOrder.product.id);
  982. });
  983. it('cancel from ArrangingPayment state', async () => {
  984. const testOrder = await createTestOrder(
  985. adminClient,
  986. shopClient,
  987. customers[0].emailAddress,
  988. password,
  989. );
  990. await proceedToArrangingPayment(shopClient);
  991. const { order } = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
  992. id: testOrder.orderId,
  993. });
  994. expect(order!.state).toBe('ArrangingPayment');
  995. await adminClient.query<CancelOrder.Mutation, CancelOrder.Variables>(CANCEL_ORDER, {
  996. input: {
  997. orderId: testOrder.orderId,
  998. },
  999. });
  1000. const { order: order2 } = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
  1001. id: testOrder.orderId,
  1002. });
  1003. expect(order2!.state).toBe('Cancelled');
  1004. expect(order2!.active).toBe(false);
  1005. await assertNoStockMovementsCreated(testOrder.product.id);
  1006. });
  1007. it('cancel from PaymentAuthorized state with cancelShipping: true', async () => {
  1008. const testOrder = await createTestOrder(
  1009. adminClient,
  1010. shopClient,
  1011. customers[0].emailAddress,
  1012. password,
  1013. );
  1014. await proceedToArrangingPayment(shopClient);
  1015. const order = await addPaymentToOrder(shopClient, failsToSettlePaymentMethod);
  1016. orderGuard.assertSuccess(order);
  1017. expect(order.state).toBe('PaymentAuthorized');
  1018. const result1 = await adminClient.query<GetStockMovement.Query, GetStockMovement.Variables>(
  1019. GET_STOCK_MOVEMENT,
  1020. {
  1021. id: 'T_3',
  1022. },
  1023. );
  1024. let variant1 = result1.product!.variants[0];
  1025. expect(variant1.stockOnHand).toBe(100);
  1026. expect(variant1.stockAllocated).toBe(2);
  1027. expect(variant1.stockMovements.items.map(pick(['type', 'quantity']))).toEqual([
  1028. { type: StockMovementType.ADJUSTMENT, quantity: 100 },
  1029. { type: StockMovementType.ALLOCATION, quantity: 2 },
  1030. ]);
  1031. const { cancelOrder } = await adminClient.query<CancelOrder.Mutation, CancelOrder.Variables>(
  1032. CANCEL_ORDER,
  1033. {
  1034. input: {
  1035. orderId: testOrder.orderId,
  1036. cancelShipping: true,
  1037. },
  1038. },
  1039. );
  1040. orderGuard.assertSuccess(cancelOrder);
  1041. expect(
  1042. cancelOrder.lines.map(l =>
  1043. l.items.map(pick(['id', 'cancelled'])).sort((a, b) => (a.id > b.id ? 1 : -1)),
  1044. ),
  1045. ).toEqual([
  1046. [
  1047. { id: 'T_11', cancelled: true },
  1048. { id: 'T_12', cancelled: true },
  1049. ],
  1050. ]);
  1051. const { order: order2 } = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
  1052. id: testOrder.orderId,
  1053. });
  1054. expect(order2!.active).toBe(false);
  1055. expect(order2!.state).toBe('Cancelled');
  1056. expect(order2!.totalWithTax).toBe(0);
  1057. expect(order2!.shippingWithTax).toBe(0);
  1058. const result2 = await adminClient.query<GetStockMovement.Query, GetStockMovement.Variables>(
  1059. GET_STOCK_MOVEMENT,
  1060. {
  1061. id: 'T_3',
  1062. },
  1063. );
  1064. variant1 = result2.product!.variants[0];
  1065. expect(variant1.stockOnHand).toBe(100);
  1066. expect(variant1.stockAllocated).toBe(0);
  1067. expect(variant1.stockMovements.items.map(pick(['type', 'quantity']))).toEqual([
  1068. { type: StockMovementType.ADJUSTMENT, quantity: 100 },
  1069. { type: StockMovementType.ALLOCATION, quantity: 2 },
  1070. { type: StockMovementType.RELEASE, quantity: 1 },
  1071. { type: StockMovementType.RELEASE, quantity: 1 },
  1072. ]);
  1073. });
  1074. async function assertNoStockMovementsCreated(productId: string) {
  1075. const result = await adminClient.query<GetStockMovement.Query, GetStockMovement.Variables>(
  1076. GET_STOCK_MOVEMENT,
  1077. {
  1078. id: productId,
  1079. },
  1080. );
  1081. const variant2 = result.product!.variants[0];
  1082. expect(variant2.stockOnHand).toBe(100);
  1083. expect(variant2.stockMovements.items.map(pick(['type', 'quantity']))).toEqual([
  1084. { type: StockMovementType.ADJUSTMENT, quantity: 100 },
  1085. ]);
  1086. }
  1087. });
  1088. describe('cancellation by OrderLine', () => {
  1089. let orderId: string;
  1090. let product: GetProductWithVariants.Product;
  1091. let productVariantId: string;
  1092. beforeAll(async () => {
  1093. const result = await createTestOrder(
  1094. adminClient,
  1095. shopClient,
  1096. customers[0].emailAddress,
  1097. password,
  1098. );
  1099. orderId = result.orderId;
  1100. product = result.product;
  1101. productVariantId = result.productVariantId;
  1102. });
  1103. it('cannot cancel from AddingItems state', async () => {
  1104. const { order } = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
  1105. id: orderId,
  1106. });
  1107. expect(order!.state).toBe('AddingItems');
  1108. const { cancelOrder } = await adminClient.query<CancelOrder.Mutation, CancelOrder.Variables>(
  1109. CANCEL_ORDER,
  1110. {
  1111. input: {
  1112. orderId,
  1113. lines: order!.lines.map(l => ({ orderLineId: l.id, quantity: 1 })),
  1114. },
  1115. },
  1116. );
  1117. orderGuard.assertErrorResult(cancelOrder);
  1118. expect(cancelOrder.message).toBe(
  1119. 'Cannot cancel OrderLines from an Order in the "AddingItems" state',
  1120. );
  1121. expect(cancelOrder.errorCode).toBe(ErrorCode.CANCEL_ACTIVE_ORDER_ERROR);
  1122. });
  1123. it('cannot cancel from ArrangingPayment state', async () => {
  1124. await proceedToArrangingPayment(shopClient);
  1125. const { order } = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
  1126. id: orderId,
  1127. });
  1128. expect(order!.state).toBe('ArrangingPayment');
  1129. const { cancelOrder } = await adminClient.query<CancelOrder.Mutation, CancelOrder.Variables>(
  1130. CANCEL_ORDER,
  1131. {
  1132. input: {
  1133. orderId,
  1134. lines: order!.lines.map(l => ({ orderLineId: l.id, quantity: 1 })),
  1135. },
  1136. },
  1137. );
  1138. orderGuard.assertErrorResult(cancelOrder);
  1139. expect(cancelOrder.message).toBe(
  1140. 'Cannot cancel OrderLines from an Order in the "ArrangingPayment" state',
  1141. );
  1142. expect(cancelOrder.errorCode).toBe(ErrorCode.CANCEL_ACTIVE_ORDER_ERROR);
  1143. });
  1144. it('returns error result if lines are empty', async () => {
  1145. const order = await addPaymentToOrder(shopClient, twoStagePaymentMethod);
  1146. orderGuard.assertSuccess(order);
  1147. expect(order.state).toBe('PaymentAuthorized');
  1148. const { cancelOrder } = await adminClient.query<CancelOrder.Mutation, CancelOrder.Variables>(
  1149. CANCEL_ORDER,
  1150. {
  1151. input: {
  1152. orderId,
  1153. lines: [],
  1154. },
  1155. },
  1156. );
  1157. orderGuard.assertErrorResult(cancelOrder);
  1158. expect(cancelOrder.message).toBe('At least one OrderLine must be specified');
  1159. expect(cancelOrder.errorCode).toBe(ErrorCode.EMPTY_ORDER_LINE_SELECTION_ERROR);
  1160. });
  1161. it('returns error result if all quantities zero', async () => {
  1162. const { order } = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
  1163. id: orderId,
  1164. });
  1165. const { cancelOrder } = await adminClient.query<CancelOrder.Mutation, CancelOrder.Variables>(
  1166. CANCEL_ORDER,
  1167. {
  1168. input: {
  1169. orderId,
  1170. lines: order!.lines.map(l => ({ orderLineId: l.id, quantity: 0 })),
  1171. },
  1172. },
  1173. );
  1174. orderGuard.assertErrorResult(cancelOrder);
  1175. expect(cancelOrder.message).toBe('At least one OrderLine must be specified');
  1176. expect(cancelOrder.errorCode).toBe(ErrorCode.EMPTY_ORDER_LINE_SELECTION_ERROR);
  1177. });
  1178. it('partial cancellation', async () => {
  1179. const result1 = await adminClient.query<GetStockMovement.Query, GetStockMovement.Variables>(
  1180. GET_STOCK_MOVEMENT,
  1181. {
  1182. id: product.id,
  1183. },
  1184. );
  1185. const variant1 = result1.product!.variants[0];
  1186. expect(variant1.stockOnHand).toBe(100);
  1187. expect(variant1.stockAllocated).toBe(2);
  1188. expect(variant1.stockMovements.items.map(pick(['type', 'quantity']))).toEqual([
  1189. { type: StockMovementType.ADJUSTMENT, quantity: 100 },
  1190. { type: StockMovementType.ALLOCATION, quantity: 2 },
  1191. { type: StockMovementType.RELEASE, quantity: 1 },
  1192. { type: StockMovementType.RELEASE, quantity: 1 },
  1193. { type: StockMovementType.ALLOCATION, quantity: 2 },
  1194. ]);
  1195. const { order } = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
  1196. id: orderId,
  1197. });
  1198. const { cancelOrder } = await adminClient.query<CancelOrder.Mutation, CancelOrder.Variables>(
  1199. CANCEL_ORDER,
  1200. {
  1201. input: {
  1202. orderId,
  1203. lines: order!.lines.map(l => ({ orderLineId: l.id, quantity: 1 })),
  1204. reason: 'cancel reason 1',
  1205. },
  1206. },
  1207. );
  1208. orderGuard.assertSuccess(cancelOrder);
  1209. expect(cancelOrder.lines[0].quantity).toBe(1);
  1210. expect(cancelOrder.lines[0].items.sort((a, b) => (a.id < b.id ? -1 : 1))).toEqual([
  1211. { id: 'T_13', cancelled: true },
  1212. { id: 'T_14', cancelled: false },
  1213. ]);
  1214. const { order: order2 } = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
  1215. id: orderId,
  1216. });
  1217. expect(order2!.state).toBe('PaymentAuthorized');
  1218. expect(order2!.lines[0].quantity).toBe(1);
  1219. const result2 = await adminClient.query<GetStockMovement.Query, GetStockMovement.Variables>(
  1220. GET_STOCK_MOVEMENT,
  1221. {
  1222. id: product.id,
  1223. },
  1224. );
  1225. const variant2 = result2.product!.variants[0];
  1226. expect(variant2.stockOnHand).toBe(100);
  1227. expect(variant2.stockAllocated).toBe(1);
  1228. expect(variant2.stockMovements.items.map(pick(['type', 'quantity']))).toEqual([
  1229. { type: StockMovementType.ADJUSTMENT, quantity: 100 },
  1230. { type: StockMovementType.ALLOCATION, quantity: 2 },
  1231. { type: StockMovementType.RELEASE, quantity: 1 },
  1232. { type: StockMovementType.RELEASE, quantity: 1 },
  1233. { type: StockMovementType.ALLOCATION, quantity: 2 },
  1234. { type: StockMovementType.RELEASE, quantity: 1 },
  1235. ]);
  1236. });
  1237. it('returns error result if attempting to cancel already cancelled item', async () => {
  1238. const { order } = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
  1239. id: orderId,
  1240. });
  1241. const { cancelOrder } = await adminClient.query<CancelOrder.Mutation, CancelOrder.Variables>(
  1242. CANCEL_ORDER,
  1243. {
  1244. input: {
  1245. orderId,
  1246. lines: order!.lines.map(l => ({ orderLineId: l.id, quantity: 2 })),
  1247. },
  1248. },
  1249. );
  1250. orderGuard.assertErrorResult(cancelOrder);
  1251. expect(cancelOrder.message).toBe(
  1252. 'The specified quantity is greater than the available OrderItems',
  1253. );
  1254. expect(cancelOrder.errorCode).toBe(ErrorCode.QUANTITY_TOO_GREAT_ERROR);
  1255. });
  1256. it('complete cancellation', async () => {
  1257. const { order } = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
  1258. id: orderId,
  1259. });
  1260. await adminClient.query<CancelOrder.Mutation, CancelOrder.Variables>(CANCEL_ORDER, {
  1261. input: {
  1262. orderId,
  1263. lines: order!.lines.map(l => ({ orderLineId: l.id, quantity: 1 })),
  1264. reason: 'cancel reason 2',
  1265. cancelShipping: true,
  1266. },
  1267. });
  1268. const { order: order2 } = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
  1269. id: orderId,
  1270. });
  1271. expect(order2!.state).toBe('Cancelled');
  1272. expect(order2!.shippingWithTax).toBe(0);
  1273. expect(order2!.totalWithTax).toBe(0);
  1274. const result = await adminClient.query<GetStockMovement.Query, GetStockMovement.Variables>(
  1275. GET_STOCK_MOVEMENT,
  1276. {
  1277. id: product.id,
  1278. },
  1279. );
  1280. const variant2 = result.product!.variants[0];
  1281. expect(variant2.stockOnHand).toBe(100);
  1282. expect(variant2.stockAllocated).toBe(0);
  1283. expect(variant2.stockMovements.items.map(pick(['type', 'quantity']))).toEqual([
  1284. { type: StockMovementType.ADJUSTMENT, quantity: 100 },
  1285. { type: StockMovementType.ALLOCATION, quantity: 2 },
  1286. { type: StockMovementType.RELEASE, quantity: 1 },
  1287. { type: StockMovementType.RELEASE, quantity: 1 },
  1288. { type: StockMovementType.ALLOCATION, quantity: 2 },
  1289. { type: StockMovementType.RELEASE, quantity: 1 },
  1290. { type: StockMovementType.RELEASE, quantity: 1 },
  1291. ]);
  1292. });
  1293. it('cancelled OrderLine.unitPrice is not zero', async () => {
  1294. const { order } = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
  1295. id: orderId,
  1296. });
  1297. expect(order?.lines[0].unitPrice).toEqual(order?.lines[0].items[0].unitPrice);
  1298. });
  1299. it('cancelled OrderLine.unitPrice is not zero', async () => {
  1300. const { order } = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
  1301. id: orderId,
  1302. });
  1303. expect(order?.lines[0].unitPrice).toEqual(order?.lines[0].items[0].unitPrice);
  1304. });
  1305. it('order history contains expected entries', async () => {
  1306. const { order } = await adminClient.query<GetOrderHistory.Query, GetOrderHistory.Variables>(
  1307. GET_ORDER_HISTORY,
  1308. {
  1309. id: orderId,
  1310. options: {
  1311. skip: 0,
  1312. },
  1313. },
  1314. );
  1315. expect(order!.history.items.map(pick(['type', 'data']))).toEqual([
  1316. {
  1317. type: HistoryEntryType.ORDER_STATE_TRANSITION,
  1318. data: {
  1319. from: 'Created',
  1320. to: 'AddingItems',
  1321. },
  1322. },
  1323. {
  1324. type: HistoryEntryType.ORDER_STATE_TRANSITION,
  1325. data: {
  1326. from: 'AddingItems',
  1327. to: 'ArrangingPayment',
  1328. },
  1329. },
  1330. {
  1331. type: HistoryEntryType.ORDER_PAYMENT_TRANSITION,
  1332. data: {
  1333. paymentId: 'T_4',
  1334. from: 'Created',
  1335. to: 'Authorized',
  1336. },
  1337. },
  1338. {
  1339. type: HistoryEntryType.ORDER_STATE_TRANSITION,
  1340. data: {
  1341. from: 'ArrangingPayment',
  1342. to: 'PaymentAuthorized',
  1343. },
  1344. },
  1345. {
  1346. type: HistoryEntryType.ORDER_CANCELLATION,
  1347. data: {
  1348. orderItemIds: ['T_13'],
  1349. reason: 'cancel reason 1',
  1350. shippingCancelled: false,
  1351. },
  1352. },
  1353. {
  1354. type: HistoryEntryType.ORDER_CANCELLATION,
  1355. data: {
  1356. orderItemIds: ['T_14'],
  1357. reason: 'cancel reason 2',
  1358. shippingCancelled: true,
  1359. },
  1360. },
  1361. {
  1362. type: HistoryEntryType.ORDER_STATE_TRANSITION,
  1363. data: {
  1364. from: 'PaymentAuthorized',
  1365. to: 'Cancelled',
  1366. },
  1367. },
  1368. ]);
  1369. });
  1370. });
  1371. describe('refunds', () => {
  1372. let orderId: string;
  1373. let product: GetProductWithVariants.Product;
  1374. let productVariantId: string;
  1375. let paymentId: string;
  1376. let refundId: string;
  1377. beforeAll(async () => {
  1378. const result = await createTestOrder(
  1379. adminClient,
  1380. shopClient,
  1381. customers[0].emailAddress,
  1382. password,
  1383. );
  1384. orderId = result.orderId;
  1385. product = result.product;
  1386. productVariantId = result.productVariantId;
  1387. });
  1388. it('cannot refund from PaymentAuthorized state', async () => {
  1389. await proceedToArrangingPayment(shopClient);
  1390. const order = await addPaymentToOrder(shopClient, twoStagePaymentMethod);
  1391. orderGuard.assertSuccess(order);
  1392. expect(order.state).toBe('PaymentAuthorized');
  1393. paymentId = order.payments![0].id;
  1394. const { refundOrder } = await adminClient.query<RefundOrder.Mutation, RefundOrder.Variables>(
  1395. REFUND_ORDER,
  1396. {
  1397. input: {
  1398. lines: order.lines.map(l => ({ orderLineId: l.id, quantity: 1 })),
  1399. shipping: 0,
  1400. adjustment: 0,
  1401. paymentId,
  1402. },
  1403. },
  1404. );
  1405. refundGuard.assertErrorResult(refundOrder);
  1406. expect(refundOrder.message).toBe('Cannot refund an Order in the "PaymentAuthorized" state');
  1407. expect(refundOrder.errorCode).toBe(ErrorCode.REFUND_ORDER_STATE_ERROR);
  1408. });
  1409. it('returns error result if no lines and no shipping', async () => {
  1410. const { order } = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
  1411. id: orderId,
  1412. });
  1413. const { settlePayment } = await adminClient.query<
  1414. SettlePayment.Mutation,
  1415. SettlePayment.Variables
  1416. >(SETTLE_PAYMENT, {
  1417. id: order!.payments![0].id,
  1418. });
  1419. paymentGuard.assertSuccess(settlePayment);
  1420. expect(settlePayment!.state).toBe('Settled');
  1421. const { refundOrder } = await adminClient.query<RefundOrder.Mutation, RefundOrder.Variables>(
  1422. REFUND_ORDER,
  1423. {
  1424. input: {
  1425. lines: order!.lines.map(l => ({ orderLineId: l.id, quantity: 0 })),
  1426. shipping: 0,
  1427. adjustment: 0,
  1428. paymentId,
  1429. },
  1430. },
  1431. );
  1432. refundGuard.assertErrorResult(refundOrder);
  1433. expect(refundOrder.message).toBe('Nothing to refund');
  1434. expect(refundOrder.errorCode).toBe(ErrorCode.NOTHING_TO_REFUND_ERROR);
  1435. });
  1436. it(
  1437. 'throws if paymentId not valid',
  1438. assertThrowsWithMessage(async () => {
  1439. const { order } = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
  1440. id: orderId,
  1441. });
  1442. const { refundOrder } = await adminClient.query<RefundOrder.Mutation, RefundOrder.Variables>(
  1443. REFUND_ORDER,
  1444. {
  1445. input: {
  1446. lines: [],
  1447. shipping: 100,
  1448. adjustment: 0,
  1449. paymentId: 'T_999',
  1450. },
  1451. },
  1452. );
  1453. }, `No Payment with the id '999' could be found`),
  1454. );
  1455. it('returns error result if payment and order lines do not belong to the same Order', async () => {
  1456. const { order } = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
  1457. id: orderId,
  1458. });
  1459. const { refundOrder } = await adminClient.query<RefundOrder.Mutation, RefundOrder.Variables>(
  1460. REFUND_ORDER,
  1461. {
  1462. input: {
  1463. lines: order!.lines.map(l => ({ orderLineId: l.id, quantity: l.quantity })),
  1464. shipping: 100,
  1465. adjustment: 0,
  1466. paymentId: 'T_1',
  1467. },
  1468. },
  1469. );
  1470. refundGuard.assertErrorResult(refundOrder);
  1471. expect(refundOrder.message).toBe('The Payment and OrderLines do not belong to the same Order');
  1472. expect(refundOrder.errorCode).toBe(ErrorCode.PAYMENT_ORDER_MISMATCH_ERROR);
  1473. });
  1474. it('creates a Refund to be manually settled', async () => {
  1475. const { order } = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
  1476. id: orderId,
  1477. });
  1478. const { refundOrder } = await adminClient.query<RefundOrder.Mutation, RefundOrder.Variables>(
  1479. REFUND_ORDER,
  1480. {
  1481. input: {
  1482. lines: order!.lines.map(l => ({ orderLineId: l.id, quantity: l.quantity })),
  1483. shipping: order!.shipping,
  1484. adjustment: 0,
  1485. reason: 'foo',
  1486. paymentId,
  1487. },
  1488. },
  1489. );
  1490. refundGuard.assertSuccess(refundOrder);
  1491. expect(refundOrder.shipping).toBe(order!.shipping);
  1492. expect(refundOrder.items).toBe(order!.subTotalWithTax);
  1493. expect(refundOrder.total).toBe(order!.totalWithTax);
  1494. expect(refundOrder.transactionId).toBe(null);
  1495. expect(refundOrder.state).toBe('Pending');
  1496. refundId = refundOrder.id;
  1497. });
  1498. it('manually settle a Refund', async () => {
  1499. const { settleRefund } = await adminClient.query<SettleRefund.Mutation, SettleRefund.Variables>(
  1500. SETTLE_REFUND,
  1501. {
  1502. input: {
  1503. id: refundId,
  1504. transactionId: 'aaabbb',
  1505. },
  1506. },
  1507. );
  1508. refundGuard.assertSuccess(settleRefund);
  1509. expect(settleRefund.state).toBe('Settled');
  1510. expect(settleRefund.transactionId).toBe('aaabbb');
  1511. });
  1512. it('returns error result if attempting to refund the same item more than once', async () => {
  1513. const { order } = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
  1514. id: orderId,
  1515. });
  1516. const { refundOrder } = await adminClient.query<RefundOrder.Mutation, RefundOrder.Variables>(
  1517. REFUND_ORDER,
  1518. {
  1519. input: {
  1520. lines: order!.lines.map(l => ({ orderLineId: l.id, quantity: l.quantity })),
  1521. shipping: order!.shipping,
  1522. adjustment: 0,
  1523. paymentId,
  1524. },
  1525. },
  1526. );
  1527. refundGuard.assertErrorResult(refundOrder);
  1528. expect(refundOrder.message).toBe(
  1529. 'The specified quantity is greater than the available OrderItems',
  1530. );
  1531. expect(refundOrder.errorCode).toBe(ErrorCode.QUANTITY_TOO_GREAT_ERROR);
  1532. });
  1533. it('order history contains expected entries', async () => {
  1534. const { order } = await adminClient.query<GetOrderHistory.Query, GetOrderHistory.Variables>(
  1535. GET_ORDER_HISTORY,
  1536. {
  1537. id: orderId,
  1538. options: {
  1539. skip: 0,
  1540. },
  1541. },
  1542. );
  1543. expect(order!.history.items.sort(sortById).map(pick(['type', 'data']))).toEqual([
  1544. {
  1545. type: HistoryEntryType.ORDER_STATE_TRANSITION,
  1546. data: {
  1547. from: 'Created',
  1548. to: 'AddingItems',
  1549. },
  1550. },
  1551. {
  1552. type: HistoryEntryType.ORDER_STATE_TRANSITION,
  1553. data: {
  1554. from: 'AddingItems',
  1555. to: 'ArrangingPayment',
  1556. },
  1557. },
  1558. {
  1559. type: HistoryEntryType.ORDER_PAYMENT_TRANSITION,
  1560. data: {
  1561. paymentId: 'T_5',
  1562. from: 'Created',
  1563. to: 'Authorized',
  1564. },
  1565. },
  1566. {
  1567. type: HistoryEntryType.ORDER_STATE_TRANSITION,
  1568. data: {
  1569. from: 'ArrangingPayment',
  1570. to: 'PaymentAuthorized',
  1571. },
  1572. },
  1573. {
  1574. type: HistoryEntryType.ORDER_PAYMENT_TRANSITION,
  1575. data: {
  1576. paymentId: 'T_5',
  1577. from: 'Authorized',
  1578. to: 'Settled',
  1579. },
  1580. },
  1581. {
  1582. type: HistoryEntryType.ORDER_STATE_TRANSITION,
  1583. data: {
  1584. from: 'PaymentAuthorized',
  1585. to: 'PaymentSettled',
  1586. },
  1587. },
  1588. {
  1589. type: HistoryEntryType.ORDER_REFUND_TRANSITION,
  1590. data: {
  1591. refundId: 'T_1',
  1592. reason: 'foo',
  1593. from: 'Pending',
  1594. to: 'Settled',
  1595. },
  1596. },
  1597. ]);
  1598. });
  1599. // https://github.com/vendure-ecommerce/vendure/issues/873
  1600. it('can add another refund if the first one fails', async () => {
  1601. const orderResult = await createTestOrder(
  1602. adminClient,
  1603. shopClient,
  1604. customers[0].emailAddress,
  1605. password,
  1606. );
  1607. await proceedToArrangingPayment(shopClient);
  1608. const order = await addPaymentToOrder(shopClient, singleStageRefundFailingPaymentMethod);
  1609. orderGuard.assertSuccess(order);
  1610. expect(order.state).toBe('PaymentSettled');
  1611. const { refundOrder: refund1 } = await adminClient.query<
  1612. RefundOrder.Mutation,
  1613. RefundOrder.Variables
  1614. >(REFUND_ORDER, {
  1615. input: {
  1616. lines: order!.lines.map(l => ({ orderLineId: l.id, quantity: l.quantity })),
  1617. shipping: order!.shipping,
  1618. adjustment: 0,
  1619. reason: 'foo',
  1620. paymentId: order.payments![0].id,
  1621. },
  1622. });
  1623. refundGuard.assertSuccess(refund1);
  1624. expect(refund1.state).toBe('Failed');
  1625. expect(refund1.total).toBe(order.totalWithTax);
  1626. const { refundOrder: refund2 } = await adminClient.query<
  1627. RefundOrder.Mutation,
  1628. RefundOrder.Variables
  1629. >(REFUND_ORDER, {
  1630. input: {
  1631. lines: order!.lines.map(l => ({ orderLineId: l.id, quantity: l.quantity })),
  1632. shipping: order!.shipping,
  1633. adjustment: 0,
  1634. reason: 'foo',
  1635. paymentId: order.payments![0].id,
  1636. },
  1637. });
  1638. refundGuard.assertSuccess(refund2);
  1639. expect(refund2.state).toBe('Settled');
  1640. expect(refund2.total).toBe(order.totalWithTax);
  1641. });
  1642. });
  1643. describe('order notes', () => {
  1644. let orderId: string;
  1645. let firstNoteId: string;
  1646. beforeAll(async () => {
  1647. const result = await createTestOrder(
  1648. adminClient,
  1649. shopClient,
  1650. customers[2].emailAddress,
  1651. password,
  1652. );
  1653. orderId = result.orderId;
  1654. });
  1655. it('private note', async () => {
  1656. const { addNoteToOrder } = await adminClient.query<
  1657. AddNoteToOrder.Mutation,
  1658. AddNoteToOrder.Variables
  1659. >(ADD_NOTE_TO_ORDER, {
  1660. input: {
  1661. id: orderId,
  1662. note: 'A private note',
  1663. isPublic: false,
  1664. },
  1665. });
  1666. expect(addNoteToOrder.id).toBe(orderId);
  1667. const { order } = await adminClient.query<GetOrderHistory.Query, GetOrderHistory.Variables>(
  1668. GET_ORDER_HISTORY,
  1669. {
  1670. id: orderId,
  1671. options: {
  1672. skip: 1,
  1673. },
  1674. },
  1675. );
  1676. expect(order!.history.items.map(pick(['type', 'data']))).toEqual([
  1677. {
  1678. type: HistoryEntryType.ORDER_NOTE,
  1679. data: {
  1680. note: 'A private note',
  1681. },
  1682. },
  1683. ]);
  1684. firstNoteId = order!.history.items[0].id;
  1685. const { activeOrder } = await shopClient.query<GetActiveOrder.Query>(GET_ACTIVE_ORDER);
  1686. expect(activeOrder!.history.items.map(pick(['type']))).toEqual([
  1687. { type: HistoryEntryType.ORDER_STATE_TRANSITION },
  1688. ]);
  1689. });
  1690. it('public note', async () => {
  1691. const { addNoteToOrder } = await adminClient.query<
  1692. AddNoteToOrder.Mutation,
  1693. AddNoteToOrder.Variables
  1694. >(ADD_NOTE_TO_ORDER, {
  1695. input: {
  1696. id: orderId,
  1697. note: 'A public note',
  1698. isPublic: true,
  1699. },
  1700. });
  1701. expect(addNoteToOrder.id).toBe(orderId);
  1702. const { order } = await adminClient.query<GetOrderHistory.Query, GetOrderHistory.Variables>(
  1703. GET_ORDER_HISTORY,
  1704. {
  1705. id: orderId,
  1706. options: {
  1707. skip: 2,
  1708. },
  1709. },
  1710. );
  1711. expect(order!.history.items.map(pick(['type', 'data']))).toEqual([
  1712. {
  1713. type: HistoryEntryType.ORDER_NOTE,
  1714. data: {
  1715. note: 'A public note',
  1716. },
  1717. },
  1718. ]);
  1719. const { activeOrder } = await shopClient.query<GetActiveOrder.Query>(GET_ACTIVE_ORDER);
  1720. expect(activeOrder!.history.items.map(pick(['type', 'data']))).toEqual([
  1721. {
  1722. type: HistoryEntryType.ORDER_STATE_TRANSITION,
  1723. data: {
  1724. from: 'Created',
  1725. to: 'AddingItems',
  1726. },
  1727. },
  1728. {
  1729. type: HistoryEntryType.ORDER_NOTE,
  1730. data: {
  1731. note: 'A public note',
  1732. },
  1733. },
  1734. ]);
  1735. });
  1736. it('update note', async () => {
  1737. const { updateOrderNote } = await adminClient.query<
  1738. UpdateOrderNote.Mutation,
  1739. UpdateOrderNote.Variables
  1740. >(UPDATE_ORDER_NOTE, {
  1741. input: {
  1742. noteId: firstNoteId,
  1743. note: 'An updated note',
  1744. },
  1745. });
  1746. expect(updateOrderNote.data).toEqual({
  1747. note: 'An updated note',
  1748. });
  1749. });
  1750. it('delete note', async () => {
  1751. const { order: before } = await adminClient.query<
  1752. GetOrderHistory.Query,
  1753. GetOrderHistory.Variables
  1754. >(GET_ORDER_HISTORY, { id: orderId });
  1755. expect(before?.history.totalItems).toBe(3);
  1756. const { deleteOrderNote } = await adminClient.query<
  1757. DeleteOrderNote.Mutation,
  1758. DeleteOrderNote.Variables
  1759. >(DELETE_ORDER_NOTE, {
  1760. id: firstNoteId,
  1761. });
  1762. expect(deleteOrderNote.result).toBe(DeletionResult.DELETED);
  1763. const { order: after } = await adminClient.query<
  1764. GetOrderHistory.Query,
  1765. GetOrderHistory.Variables
  1766. >(GET_ORDER_HISTORY, { id: orderId });
  1767. expect(after?.history.totalItems).toBe(2);
  1768. });
  1769. });
  1770. describe('multiple payments', () => {
  1771. const PARTIAL_PAYMENT_AMOUNT = 1000;
  1772. let orderId: string;
  1773. let orderTotalWithTax: number;
  1774. let payment1Id: string;
  1775. let payment2Id: string;
  1776. let productInOrder: GetProductWithVariants.Product;
  1777. beforeAll(async () => {
  1778. const result = await createTestOrder(
  1779. adminClient,
  1780. shopClient,
  1781. customers[1].emailAddress,
  1782. password,
  1783. );
  1784. orderId = result.orderId;
  1785. productInOrder = result.product;
  1786. });
  1787. it('adds a partial payment', async () => {
  1788. await proceedToArrangingPayment(shopClient);
  1789. const { addPaymentToOrder: order } = await shopClient.query<
  1790. AddPaymentToOrder.Mutation,
  1791. AddPaymentToOrder.Variables
  1792. >(ADD_PAYMENT, {
  1793. input: {
  1794. method: partialPaymentMethod.code,
  1795. metadata: {
  1796. amount: PARTIAL_PAYMENT_AMOUNT,
  1797. },
  1798. },
  1799. });
  1800. orderGuard.assertSuccess(order);
  1801. orderTotalWithTax = order.totalWithTax;
  1802. expect(order.state).toBe('ArrangingPayment');
  1803. expect(order.payments?.length).toBe(1);
  1804. expect(omit(order.payments![0], ['id'])).toEqual({
  1805. amount: PARTIAL_PAYMENT_AMOUNT,
  1806. metadata: {
  1807. public: {
  1808. amount: PARTIAL_PAYMENT_AMOUNT,
  1809. },
  1810. },
  1811. method: partialPaymentMethod.code,
  1812. state: 'Settled',
  1813. transactionId: '12345',
  1814. });
  1815. payment1Id = order.payments![0].id;
  1816. });
  1817. it('adds another payment to make up order totalWithTax', async () => {
  1818. const { addPaymentToOrder: order } = await shopClient.query<
  1819. AddPaymentToOrder.Mutation,
  1820. AddPaymentToOrder.Variables
  1821. >(ADD_PAYMENT, {
  1822. input: {
  1823. method: singleStageRefundablePaymentMethod.code,
  1824. metadata: {},
  1825. },
  1826. });
  1827. orderGuard.assertSuccess(order);
  1828. expect(order.state).toBe('PaymentSettled');
  1829. expect(order.payments?.length).toBe(2);
  1830. expect(
  1831. omit(order.payments?.find(p => p.method === singleStageRefundablePaymentMethod.code)!, [
  1832. 'id',
  1833. ]),
  1834. ).toEqual({
  1835. amount: orderTotalWithTax - PARTIAL_PAYMENT_AMOUNT,
  1836. metadata: {},
  1837. method: singleStageRefundablePaymentMethod.code,
  1838. state: 'Settled',
  1839. transactionId: '12345',
  1840. });
  1841. payment2Id = order.payments![1].id;
  1842. });
  1843. it('partial refunding of order with multiple payments', async () => {
  1844. const { order } = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
  1845. id: orderId,
  1846. });
  1847. const { refundOrder } = await adminClient.query<RefundOrder.Mutation, RefundOrder.Variables>(
  1848. REFUND_ORDER,
  1849. {
  1850. input: {
  1851. lines: order!.lines.map(l => ({ orderLineId: l.id, quantity: 1 })),
  1852. shipping: 0,
  1853. adjustment: 0,
  1854. reason: 'foo',
  1855. paymentId: payment1Id,
  1856. },
  1857. },
  1858. );
  1859. refundGuard.assertSuccess(refundOrder);
  1860. expect(refundOrder.total).toBe(PARTIAL_PAYMENT_AMOUNT);
  1861. const { order: orderWithPayments } = await adminClient.query<
  1862. GetOrderWithPayments.Query,
  1863. GetOrderWithPayments.Variables
  1864. >(GET_ORDER_WITH_PAYMENTS, {
  1865. id: orderId,
  1866. });
  1867. expect(orderWithPayments?.payments![0].refunds.length).toBe(1);
  1868. expect(orderWithPayments?.payments![0].refunds[0].total).toBe(PARTIAL_PAYMENT_AMOUNT);
  1869. expect(orderWithPayments?.payments![1].refunds.length).toBe(1);
  1870. expect(orderWithPayments?.payments![1].refunds[0].total).toBe(
  1871. productInOrder.variants[0].priceWithTax - PARTIAL_PAYMENT_AMOUNT,
  1872. );
  1873. });
  1874. it('refunding remaining amount of order with multiple payments', async () => {
  1875. const { order } = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
  1876. id: orderId,
  1877. });
  1878. const { refundOrder } = await adminClient.query<RefundOrder.Mutation, RefundOrder.Variables>(
  1879. REFUND_ORDER,
  1880. {
  1881. input: {
  1882. lines: order!.lines.map(l => ({ orderLineId: l.id, quantity: 1 })),
  1883. shipping: order!.shippingWithTax,
  1884. adjustment: 0,
  1885. reason: 'foo',
  1886. paymentId: payment1Id,
  1887. },
  1888. },
  1889. );
  1890. refundGuard.assertSuccess(refundOrder);
  1891. expect(refundOrder.total).toBe(order!.totalWithTax - order!.lines[0].unitPriceWithTax);
  1892. const { order: orderWithPayments } = await adminClient.query<
  1893. GetOrderWithPayments.Query,
  1894. GetOrderWithPayments.Variables
  1895. >(GET_ORDER_WITH_PAYMENTS, {
  1896. id: orderId,
  1897. });
  1898. expect(orderWithPayments?.payments![0].refunds.length).toBe(1);
  1899. expect(orderWithPayments?.payments![0].refunds[0].total).toBe(PARTIAL_PAYMENT_AMOUNT);
  1900. expect(orderWithPayments?.payments![1].refunds.length).toBe(2);
  1901. expect(orderWithPayments?.payments![1].refunds[0].total).toBe(
  1902. productInOrder.variants[0].priceWithTax - PARTIAL_PAYMENT_AMOUNT,
  1903. );
  1904. expect(orderWithPayments?.payments![1].refunds[1].total).toBe(
  1905. productInOrder.variants[0].priceWithTax + order!.shippingWithTax,
  1906. );
  1907. });
  1908. // https://github.com/vendure-ecommerce/vendure/issues/847
  1909. it('manual call to settlePayment works with multiple payments', async () => {
  1910. const result = await createTestOrder(
  1911. adminClient,
  1912. shopClient,
  1913. customers[1].emailAddress,
  1914. password,
  1915. );
  1916. await proceedToArrangingPayment(shopClient);
  1917. await shopClient.query<AddPaymentToOrder.Mutation, AddPaymentToOrder.Variables>(ADD_PAYMENT, {
  1918. input: {
  1919. method: partialPaymentMethod.code,
  1920. metadata: {
  1921. amount: PARTIAL_PAYMENT_AMOUNT,
  1922. authorizeOnly: true,
  1923. },
  1924. },
  1925. });
  1926. const { addPaymentToOrder: order } = await shopClient.query<
  1927. AddPaymentToOrder.Mutation,
  1928. AddPaymentToOrder.Variables
  1929. >(ADD_PAYMENT, {
  1930. input: {
  1931. method: singleStageRefundablePaymentMethod.code,
  1932. metadata: {},
  1933. },
  1934. });
  1935. orderGuard.assertSuccess(order);
  1936. expect(order.state).toBe('PaymentAuthorized');
  1937. const { settlePayment } = await adminClient.query<
  1938. SettlePayment.Mutation,
  1939. SettlePayment.Variables
  1940. >(SETTLE_PAYMENT, {
  1941. id: order.payments!.find(p => p.method === partialPaymentMethod.code)!.id,
  1942. });
  1943. paymentGuard.assertSuccess(settlePayment);
  1944. expect(settlePayment.state).toBe('Settled');
  1945. const { order: order2 } = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
  1946. id: order.id,
  1947. });
  1948. expect(order2?.state).toBe('PaymentSettled');
  1949. });
  1950. });
  1951. describe('issues', () => {
  1952. // https://github.com/vendure-ecommerce/vendure/issues/639
  1953. it('returns fulfillments for Order with no lines', async () => {
  1954. await shopClient.asAnonymousUser();
  1955. // Apply a coupon code just to create an active order with no OrderLines
  1956. await shopClient.query<ApplyCouponCode.Mutation, ApplyCouponCode.Variables>(APPLY_COUPON_CODE, {
  1957. couponCode: 'TEST',
  1958. });
  1959. const { activeOrder } = await shopClient.query<GetActiveOrder.Query>(GET_ACTIVE_ORDER);
  1960. const { order } = await adminClient.query<
  1961. GetOrderFulfillments.Query,
  1962. GetOrderFulfillments.Variables
  1963. >(GET_ORDER_FULFILLMENTS, {
  1964. id: activeOrder!.id,
  1965. });
  1966. expect(order?.fulfillments).toEqual([]);
  1967. });
  1968. // https://github.com/vendure-ecommerce/vendure/issues/603
  1969. it('orders correctly resolves quantities and OrderItems', async () => {
  1970. await shopClient.asAnonymousUser();
  1971. const { addItemToOrder } = await shopClient.query<
  1972. AddItemToOrder.Mutation,
  1973. AddItemToOrder.Variables
  1974. >(ADD_ITEM_TO_ORDER, {
  1975. productVariantId: 'T_1',
  1976. quantity: 2,
  1977. });
  1978. orderGuard.assertSuccess(addItemToOrder);
  1979. const { orders } = await adminClient.query<
  1980. GetOrderListWithQty.Query,
  1981. GetOrderListWithQty.Variables
  1982. >(GET_ORDERS_LIST_WITH_QUANTITIES, {
  1983. options: {
  1984. filter: {
  1985. code: { eq: addItemToOrder.code },
  1986. },
  1987. },
  1988. });
  1989. expect(orders.items[0].totalQuantity).toBe(2);
  1990. expect(orders.items[0].lines[0].quantity).toBe(2);
  1991. });
  1992. // https://github.com/vendure-ecommerce/vendure/issues/716
  1993. it('get an Order with a deleted ShippingMethod', async () => {
  1994. const { createShippingMethod: shippingMethod } = await adminClient.query<
  1995. CreateShippingMethod.Mutation,
  1996. CreateShippingMethod.Variables
  1997. >(CREATE_SHIPPING_METHOD, {
  1998. input: {
  1999. code: 'royal-mail',
  2000. translations: [{ languageCode: LanguageCode.en, name: 'Royal Mail', description: '' }],
  2001. fulfillmentHandler: manualFulfillmentHandler.code,
  2002. checker: {
  2003. code: defaultShippingEligibilityChecker.code,
  2004. arguments: [{ name: 'orderMinimum', value: '0' }],
  2005. },
  2006. calculator: {
  2007. code: defaultShippingCalculator.code,
  2008. arguments: [
  2009. { name: 'rate', value: '500' },
  2010. { name: 'taxRate', value: '0' },
  2011. ],
  2012. },
  2013. },
  2014. });
  2015. await shopClient.asUserWithCredentials(customers[0].emailAddress, password);
  2016. await shopClient.query<AddItemToOrder.Mutation, AddItemToOrder.Variables>(ADD_ITEM_TO_ORDER, {
  2017. productVariantId: 'T_1',
  2018. quantity: 2,
  2019. });
  2020. await shopClient.query<SetShippingAddress.Mutation, SetShippingAddress.Variables>(
  2021. SET_SHIPPING_ADDRESS,
  2022. {
  2023. input: {
  2024. fullName: 'name',
  2025. streetLine1: '12 the street',
  2026. city: 'foo',
  2027. postalCode: '123456',
  2028. countryCode: 'US',
  2029. },
  2030. },
  2031. );
  2032. const { setOrderShippingMethod: order } = await shopClient.query<
  2033. SetShippingMethod.Mutation,
  2034. SetShippingMethod.Variables
  2035. >(SET_SHIPPING_METHOD, {
  2036. id: shippingMethod.id,
  2037. });
  2038. orderGuard.assertSuccess(order);
  2039. await adminClient.query<DeleteShippingMethod.Mutation, DeleteShippingMethod.Variables>(
  2040. DELETE_SHIPPING_METHOD,
  2041. {
  2042. id: shippingMethod.id,
  2043. },
  2044. );
  2045. const { order: order2 } = await adminClient.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
  2046. id: order.id,
  2047. });
  2048. expect(order2?.shippingLines[0]).toEqual({
  2049. priceWithTax: 500,
  2050. shippingMethod: pick(shippingMethod, ['id', 'name', 'code', 'description']),
  2051. });
  2052. });
  2053. // https://github.com/vendure-ecommerce/vendure/issues/868
  2054. it('allows multiple refunds of same OrderLine', async () => {
  2055. await shopClient.asUserWithCredentials(customers[0].emailAddress, password);
  2056. const { addItemToOrder } = await shopClient.query<
  2057. AddItemToOrder.Mutation,
  2058. AddItemToOrder.Variables
  2059. >(ADD_ITEM_TO_ORDER, {
  2060. productVariantId: 'T_1',
  2061. quantity: 2,
  2062. });
  2063. await proceedToArrangingPayment(shopClient);
  2064. const order = await addPaymentToOrder(shopClient, singleStageRefundablePaymentMethod);
  2065. orderGuard.assertSuccess(order);
  2066. const { refundOrder: refund1 } = await adminClient.query<
  2067. RefundOrder.Mutation,
  2068. RefundOrder.Variables
  2069. >(REFUND_ORDER, {
  2070. input: {
  2071. lines: order!.lines.map(l => ({ orderLineId: l.id, quantity: 1 })),
  2072. shipping: 0,
  2073. adjustment: 0,
  2074. reason: 'foo',
  2075. paymentId: order.payments![0].id,
  2076. },
  2077. });
  2078. refundGuard.assertSuccess(refund1);
  2079. const { refundOrder: refund2 } = await adminClient.query<
  2080. RefundOrder.Mutation,
  2081. RefundOrder.Variables
  2082. >(REFUND_ORDER, {
  2083. input: {
  2084. lines: order!.lines.map(l => ({ orderLineId: l.id, quantity: 1 })),
  2085. shipping: 0,
  2086. adjustment: 0,
  2087. reason: 'foo',
  2088. paymentId: order.payments![0].id,
  2089. },
  2090. });
  2091. refundGuard.assertSuccess(refund2);
  2092. });
  2093. // https://github.com/vendure-ecommerce/vendure/issues/1125
  2094. it('resolves deleted Product of OrderLine ProductVariants', async () => {
  2095. await shopClient.asUserWithCredentials(customers[0].emailAddress, password);
  2096. const { addItemToOrder } = await shopClient.query<
  2097. AddItemToOrder.Mutation,
  2098. AddItemToOrder.Variables
  2099. >(ADD_ITEM_TO_ORDER, {
  2100. productVariantId: 'T_7',
  2101. quantity: 1,
  2102. });
  2103. await proceedToArrangingPayment(shopClient);
  2104. const order = await addPaymentToOrder(shopClient, singleStageRefundablePaymentMethod);
  2105. orderGuard.assertSuccess(order);
  2106. await adminClient.query<DeleteProduct.Mutation, DeleteProduct.Variables>(DELETE_PRODUCT, {
  2107. id: 'T_3',
  2108. });
  2109. const { activeCustomer } = await shopClient.query<
  2110. GetActiveCustomerWithOrdersProductSlug.Query,
  2111. GetActiveCustomerWithOrdersProductSlug.Variables
  2112. >(GET_ACTIVE_CUSTOMER_WITH_ORDERS_PRODUCT_SLUG, {
  2113. options: {
  2114. sort: {
  2115. createdAt: SortOrder.ASC,
  2116. },
  2117. },
  2118. });
  2119. expect(
  2120. activeCustomer!.orders.items[activeCustomer!.orders.items.length - 1].lines[0].productVariant
  2121. .product.slug,
  2122. ).toBe('gaming-pc');
  2123. });
  2124. // https://github.com/vendure-ecommerce/vendure/issues/1508
  2125. it('resolves price of deleted ProductVariant of OrderLine', async () => {
  2126. const { activeCustomer } = await shopClient.query<
  2127. GetActiveCustomerWithOrdersProductPrice.Query,
  2128. GetActiveCustomerWithOrdersProductPrice.Variables
  2129. >(GET_ACTIVE_CUSTOMER_WITH_ORDERS_PRODUCT_PRICE, {
  2130. options: {
  2131. sort: {
  2132. createdAt: SortOrder.ASC,
  2133. },
  2134. },
  2135. });
  2136. expect(
  2137. activeCustomer!.orders.items[activeCustomer!.orders.items.length - 1].lines[0].productVariant
  2138. .price,
  2139. ).toBe(108720);
  2140. });
  2141. });
  2142. });
  2143. async function createTestOrder(
  2144. adminClient: SimpleGraphQLClient,
  2145. shopClient: SimpleGraphQLClient,
  2146. emailAddress: string,
  2147. password: string,
  2148. ): Promise<{
  2149. orderId: string;
  2150. product: GetProductWithVariants.Product;
  2151. productVariantId: string;
  2152. }> {
  2153. const result = await adminClient.query<GetProductWithVariants.Query, GetProductWithVariants.Variables>(
  2154. GET_PRODUCT_WITH_VARIANTS,
  2155. {
  2156. id: 'T_3',
  2157. },
  2158. );
  2159. const product = result.product!;
  2160. const productVariantId = product.variants[0].id;
  2161. // Set the ProductVariant to trackInventory
  2162. const { updateProductVariants } = await adminClient.query<
  2163. UpdateProductVariants.Mutation,
  2164. UpdateProductVariants.Variables
  2165. >(UPDATE_PRODUCT_VARIANTS, {
  2166. input: [
  2167. {
  2168. id: productVariantId,
  2169. trackInventory: GlobalFlag.TRUE,
  2170. },
  2171. ],
  2172. });
  2173. // Add the ProductVariant to the Order
  2174. await shopClient.asUserWithCredentials(emailAddress, password);
  2175. const { addItemToOrder } = await shopClient.query<AddItemToOrder.Mutation, AddItemToOrder.Variables>(
  2176. ADD_ITEM_TO_ORDER,
  2177. {
  2178. productVariantId,
  2179. quantity: 2,
  2180. },
  2181. );
  2182. const orderId = (addItemToOrder as UpdatedOrder.Fragment).id;
  2183. return { product, productVariantId, orderId };
  2184. }
  2185. async function getUnfulfilledOrderLineInput(
  2186. client: SimpleGraphQLClient,
  2187. id: string,
  2188. ): Promise<OrderLineInput[]> {
  2189. const { order } = await client.query<GetOrder.Query, GetOrder.Variables>(GET_ORDER, {
  2190. id,
  2191. });
  2192. const unfulfilledItems =
  2193. order?.lines.filter(l => {
  2194. const items = l.items.filter(i => i.fulfillment === null);
  2195. return items.length > 0 ? true : false;
  2196. }) || [];
  2197. return unfulfilledItems.map(l => ({
  2198. orderLineId: l.id,
  2199. quantity: l.items.length,
  2200. }));
  2201. }
  2202. export const GET_ORDER_LIST_FULFILLMENTS = gql`
  2203. query GetOrderListFulfillments {
  2204. orders {
  2205. items {
  2206. id
  2207. state
  2208. fulfillments {
  2209. id
  2210. state
  2211. nextStates
  2212. method
  2213. }
  2214. }
  2215. }
  2216. }
  2217. `;
  2218. export const GET_ORDER_FULFILLMENT_ITEMS = gql`
  2219. query GetOrderFulfillmentItems($id: ID!) {
  2220. order(id: $id) {
  2221. id
  2222. state
  2223. fulfillments {
  2224. ...Fulfillment
  2225. }
  2226. }
  2227. }
  2228. ${FULFILLMENT_FRAGMENT}
  2229. `;
  2230. const REFUND_FRAGMENT = gql`
  2231. fragment Refund on Refund {
  2232. id
  2233. state
  2234. items
  2235. transactionId
  2236. shipping
  2237. total
  2238. metadata
  2239. }
  2240. `;
  2241. export const REFUND_ORDER = gql`
  2242. mutation RefundOrder($input: RefundOrderInput!) {
  2243. refundOrder(input: $input) {
  2244. ...Refund
  2245. ... on ErrorResult {
  2246. errorCode
  2247. message
  2248. }
  2249. }
  2250. }
  2251. ${REFUND_FRAGMENT}
  2252. `;
  2253. export const SETTLE_REFUND = gql`
  2254. mutation SettleRefund($input: SettleRefundInput!) {
  2255. settleRefund(input: $input) {
  2256. ...Refund
  2257. ... on ErrorResult {
  2258. errorCode
  2259. message
  2260. }
  2261. }
  2262. }
  2263. ${REFUND_FRAGMENT}
  2264. `;
  2265. export const ADD_NOTE_TO_ORDER = gql`
  2266. mutation AddNoteToOrder($input: AddNoteToOrderInput!) {
  2267. addNoteToOrder(input: $input) {
  2268. id
  2269. }
  2270. }
  2271. `;
  2272. export const UPDATE_ORDER_NOTE = gql`
  2273. mutation UpdateOrderNote($input: UpdateOrderNoteInput!) {
  2274. updateOrderNote(input: $input) {
  2275. id
  2276. data
  2277. isPublic
  2278. }
  2279. }
  2280. `;
  2281. export const DELETE_ORDER_NOTE = gql`
  2282. mutation DeleteOrderNote($id: ID!) {
  2283. deleteOrderNote(id: $id) {
  2284. result
  2285. message
  2286. }
  2287. }
  2288. `;
  2289. const GET_ORDER_WITH_PAYMENTS = gql`
  2290. query GetOrderWithPayments($id: ID!) {
  2291. order(id: $id) {
  2292. id
  2293. payments {
  2294. id
  2295. errorMessage
  2296. metadata
  2297. refunds {
  2298. id
  2299. total
  2300. }
  2301. }
  2302. }
  2303. }
  2304. `;
  2305. const GET_ORDERS_LIST_WITH_QUANTITIES = gql`
  2306. query GetOrderListWithQty($options: OrderListOptions) {
  2307. orders(options: $options) {
  2308. items {
  2309. id
  2310. code
  2311. totalQuantity
  2312. lines {
  2313. id
  2314. quantity
  2315. }
  2316. }
  2317. }
  2318. }
  2319. `;