order.e2e-spec.ts 117 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152
  1. /* eslint-disable @typescript-eslint/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 { afterAll, beforeAll, describe, expect, it } from 'vitest';
  19. import { initialData } from '../../../e2e-common/e2e-initial-data';
  20. import { TEST_SETUP_TIMEOUT_MS, testConfig } from '../../../e2e-common/test-config';
  21. import {
  22. failsToCancelPaymentMethod,
  23. failsToSettlePaymentMethod,
  24. onCancelPaymentSpy,
  25. onTransitionSpy,
  26. partialPaymentMethod,
  27. singleStageRefundablePaymentMethod,
  28. singleStageRefundFailingPaymentMethod,
  29. twoStagePaymentMethod,
  30. } from './fixtures/test-payment-methods';
  31. import { FULFILLMENT_FRAGMENT, PAYMENT_FRAGMENT } from './graphql/fragments';
  32. import * as Codegen from './graphql/generated-e2e-admin-types';
  33. import {
  34. AddManualPaymentDocument,
  35. CanceledOrderFragment,
  36. CreateFulfillmentDocument,
  37. ErrorCode,
  38. FulfillmentFragment,
  39. GetOrderDocument,
  40. GetOrderHistoryDocument,
  41. GlobalFlag,
  42. HistoryEntryType,
  43. LanguageCode,
  44. OrderLineInput,
  45. PaymentFragment,
  46. RefundFragment,
  47. RefundOrderDocument,
  48. SortOrder,
  49. StockMovementType,
  50. TransitFulfillmentDocument,
  51. } from './graphql/generated-e2e-admin-types';
  52. import * as CodegenShop from './graphql/generated-e2e-shop-types';
  53. import {
  54. DeletionResult,
  55. TestOrderFragmentFragment,
  56. UpdatedOrderFragment,
  57. } from './graphql/generated-e2e-shop-types';
  58. import {
  59. CANCEL_ORDER,
  60. CREATE_FULFILLMENT,
  61. CREATE_SHIPPING_METHOD,
  62. DELETE_PRODUCT,
  63. DELETE_SHIPPING_METHOD,
  64. GET_CUSTOMER_LIST,
  65. GET_ORDER,
  66. GET_ORDER_FULFILLMENTS,
  67. GET_ORDER_HISTORY,
  68. GET_ORDERS_LIST,
  69. GET_PRODUCT_WITH_VARIANTS,
  70. GET_STOCK_MOVEMENT,
  71. SETTLE_PAYMENT,
  72. TRANSIT_FULFILLMENT,
  73. UPDATE_PRODUCT_VARIANTS,
  74. } from './graphql/shared-definitions';
  75. import {
  76. ADD_ITEM_TO_ORDER,
  77. ADD_MULTIPLE_ITEMS_TO_ORDER,
  78. ADD_PAYMENT,
  79. APPLY_COUPON_CODE,
  80. GET_ACTIVE_CUSTOMER_WITH_ORDERS_PRODUCT_PRICE,
  81. GET_ACTIVE_CUSTOMER_WITH_ORDERS_PRODUCT_SLUG,
  82. GET_ACTIVE_ORDER,
  83. GET_ORDER_BY_CODE_WITH_PAYMENTS,
  84. SET_SHIPPING_ADDRESS,
  85. SET_SHIPPING_METHOD,
  86. } from './graphql/shop-definitions';
  87. import { assertThrowsWithMessage } from './utils/assert-throws-with-message';
  88. import { addPaymentToOrder, proceedToArrangingPayment, sortById } from './utils/test-order-utils';
  89. describe('Orders resolver', () => {
  90. const { server, adminClient, shopClient } = createTestEnvironment(
  91. mergeConfig(testConfig(), {
  92. paymentOptions: {
  93. paymentMethodHandlers: [
  94. twoStagePaymentMethod,
  95. failsToSettlePaymentMethod,
  96. singleStageRefundablePaymentMethod,
  97. partialPaymentMethod,
  98. singleStageRefundFailingPaymentMethod,
  99. failsToCancelPaymentMethod,
  100. ],
  101. },
  102. }),
  103. );
  104. let customers: Codegen.GetCustomerListQuery['customers']['items'];
  105. const password = 'test';
  106. const orderGuard: ErrorResultGuard<
  107. TestOrderFragmentFragment | CanceledOrderFragment | UpdatedOrderFragment
  108. > = createErrorResultGuard(input => !!input.lines);
  109. const paymentGuard: ErrorResultGuard<PaymentFragment> = createErrorResultGuard(input => !!input.state);
  110. const fulfillmentGuard: ErrorResultGuard<FulfillmentFragment> = createErrorResultGuard(
  111. input => !!input.method,
  112. );
  113. const refundGuard: ErrorResultGuard<RefundFragment> = createErrorResultGuard(input => !!input.total);
  114. beforeAll(async () => {
  115. await server.init({
  116. initialData: {
  117. ...initialData,
  118. paymentMethods: [
  119. {
  120. name: twoStagePaymentMethod.code,
  121. handler: { code: twoStagePaymentMethod.code, arguments: [] },
  122. },
  123. {
  124. name: failsToSettlePaymentMethod.code,
  125. handler: { code: failsToSettlePaymentMethod.code, arguments: [] },
  126. },
  127. {
  128. name: failsToCancelPaymentMethod.code,
  129. handler: { code: failsToCancelPaymentMethod.code, arguments: [] },
  130. },
  131. {
  132. name: singleStageRefundablePaymentMethod.code,
  133. handler: { code: singleStageRefundablePaymentMethod.code, arguments: [] },
  134. },
  135. {
  136. name: singleStageRefundFailingPaymentMethod.code,
  137. handler: { code: singleStageRefundFailingPaymentMethod.code, arguments: [] },
  138. },
  139. {
  140. name: partialPaymentMethod.code,
  141. handler: { code: partialPaymentMethod.code, arguments: [] },
  142. },
  143. ],
  144. },
  145. productsCsvPath: path.join(__dirname, 'fixtures/e2e-products-full.csv'),
  146. customerCount: 3,
  147. });
  148. await adminClient.asSuperAdmin();
  149. // Create a couple of orders to be queried
  150. const result = await adminClient.query<
  151. Codegen.GetCustomerListQuery,
  152. Codegen.GetCustomerListQueryVariables
  153. >(GET_CUSTOMER_LIST, {
  154. options: {
  155. take: 3,
  156. },
  157. });
  158. customers = result.customers.items;
  159. await shopClient.asUserWithCredentials(customers[0].emailAddress, password);
  160. await shopClient.query<
  161. CodegenShop.AddItemToOrderMutation,
  162. CodegenShop.AddItemToOrderMutationVariables
  163. >(ADD_ITEM_TO_ORDER, {
  164. productVariantId: 'T_1',
  165. quantity: 1,
  166. });
  167. await shopClient.query<
  168. CodegenShop.AddItemToOrderMutation,
  169. CodegenShop.AddItemToOrderMutationVariables
  170. >(ADD_ITEM_TO_ORDER, {
  171. productVariantId: 'T_2',
  172. quantity: 1,
  173. });
  174. await shopClient.asUserWithCredentials(customers[1].emailAddress, password);
  175. await shopClient.query<
  176. CodegenShop.AddItemToOrderMutation,
  177. CodegenShop.AddItemToOrderMutationVariables
  178. >(ADD_ITEM_TO_ORDER, {
  179. productVariantId: 'T_2',
  180. quantity: 1,
  181. });
  182. await shopClient.query<
  183. CodegenShop.AddItemToOrderMutation,
  184. CodegenShop.AddItemToOrderMutationVariables
  185. >(ADD_ITEM_TO_ORDER, {
  186. productVariantId: 'T_3',
  187. quantity: 3,
  188. });
  189. }, TEST_SETUP_TIMEOUT_MS);
  190. afterAll(async () => {
  191. await server.destroy();
  192. });
  193. it('order history initially contains Created -> AddingItems transition', async () => {
  194. const { order } = await adminClient.query<
  195. Codegen.GetOrderHistoryQuery,
  196. Codegen.GetOrderHistoryQueryVariables
  197. >(GET_ORDER_HISTORY, { id: 'T_1' });
  198. expect(order!.history.totalItems).toBe(1);
  199. expect(order!.history.items.map(pick(['type', 'data']))).toEqual([
  200. {
  201. type: HistoryEntryType.ORDER_STATE_TRANSITION,
  202. data: {
  203. from: 'Created',
  204. to: 'AddingItems',
  205. },
  206. },
  207. ]);
  208. });
  209. describe('querying', () => {
  210. it('orders', async () => {
  211. const result = await adminClient.query<Codegen.GetOrderListQuery>(GET_ORDERS_LIST);
  212. expect(result.orders.items.map(o => o.id).sort()).toEqual(['T_1', 'T_2']);
  213. });
  214. it('filtering by total', async () => {
  215. const result = await adminClient.query<
  216. Codegen.GetOrderListQuery,
  217. Codegen.GetOrderListQueryVariables
  218. >(GET_ORDERS_LIST, {
  219. options: {
  220. filter: { total: { gt: 1000_00 } },
  221. },
  222. });
  223. expect(result.orders.items.map(o => o.id).sort()).toEqual(['T_1', 'T_2']);
  224. });
  225. it('filtering by total using boolean expression', async () => {
  226. const result = await adminClient.query<
  227. Codegen.GetOrderListQuery,
  228. Codegen.GetOrderListQueryVariables
  229. >(GET_ORDERS_LIST, {
  230. options: {
  231. filter: {
  232. _and: [{ total: { gt: 1000_00 } }],
  233. },
  234. },
  235. });
  236. expect(result.orders.items.map(o => o.id).sort()).toEqual(['T_1', 'T_2']);
  237. });
  238. it('order', async () => {
  239. const result = await adminClient.query<Codegen.GetOrderQuery, Codegen.GetOrderQueryVariables>(
  240. GET_ORDER,
  241. {
  242. id: 'T_2',
  243. },
  244. );
  245. expect(result.order!.id).toBe('T_2');
  246. });
  247. it('correctly resolves asset preview urls with edge-case query', async () => {
  248. // This came up as a strange edge-case where the AssetInterceptorPlugin was unable to
  249. // correctly transform the asset preview URL. It is not directly to do with Orders per se,
  250. // but manifested when attempting an order-related query.
  251. const result = await adminClient.query<Codegen.GetOrderQuery, Codegen.GetOrderQueryVariables>(
  252. gql(`
  253. query OrderAssetEdgeCase($id: ID!) {
  254. order(id: $id) {
  255. lines {
  256. id
  257. }
  258. ...OrderDetail
  259. }
  260. }
  261. fragment OrderDetail on Order {
  262. id
  263. lines {
  264. ...OrderLine
  265. }
  266. }
  267. fragment OrderLine on OrderLine {
  268. id
  269. featuredAsset {
  270. preview
  271. }
  272. }
  273. `),
  274. {
  275. id: 'T_2',
  276. },
  277. );
  278. expect(result.order!.lines.length).toBe(2);
  279. expect(result.order!.lines.map(l => l.featuredAsset?.preview)).toEqual([
  280. 'test-url/test-assets/derick-david-409858-unsplash__preview.jpg',
  281. 'test-url/test-assets/derick-david-409858-unsplash__preview.jpg',
  282. ]);
  283. });
  284. it('order with calculated line properties', async () => {
  285. const result = await adminClient.query<Codegen.GetOrderQuery, Codegen.GetOrderQueryVariables>(
  286. gql`
  287. query GetOrderWithLineCalculatedProps($id: ID!) {
  288. order(id: $id) {
  289. id
  290. lines {
  291. id
  292. linePriceWithTax
  293. quantity
  294. }
  295. }
  296. }
  297. `,
  298. {
  299. id: 'T_2',
  300. },
  301. );
  302. expect(result.order!.lines).toEqual([
  303. {
  304. id: 'T_3',
  305. linePriceWithTax: 167880,
  306. quantity: 1,
  307. },
  308. {
  309. id: 'T_4',
  310. linePriceWithTax: 791640,
  311. quantity: 3,
  312. },
  313. ]);
  314. });
  315. it('sort by total', async () => {
  316. const result = await adminClient.query<
  317. Codegen.GetOrderListQuery,
  318. Codegen.GetOrderListQueryVariables
  319. >(GET_ORDERS_LIST, {
  320. options: {
  321. sort: {
  322. total: SortOrder.DESC,
  323. },
  324. take: 10,
  325. },
  326. });
  327. expect(result.orders.items.map(o => pick(o, ['id', 'total']))).toEqual([
  328. { id: 'T_2', total: 799600 },
  329. { id: 'T_1', total: 269800 },
  330. ]);
  331. });
  332. it('sort by totalWithTax', async () => {
  333. const result = await adminClient.query<
  334. Codegen.GetOrderListQuery,
  335. Codegen.GetOrderListQueryVariables
  336. >(GET_ORDERS_LIST, {
  337. options: {
  338. sort: {
  339. totalWithTax: SortOrder.DESC,
  340. },
  341. take: 10,
  342. },
  343. });
  344. expect(result.orders.items.map(o => pick(o, ['id', 'totalWithTax']))).toEqual([
  345. { id: 'T_2', totalWithTax: 959520 },
  346. { id: 'T_1', totalWithTax: 323760 },
  347. ]);
  348. });
  349. it('sort by totalQuantity', async () => {
  350. const result = await adminClient.query<
  351. Codegen.GetOrderListQuery,
  352. Codegen.GetOrderListQueryVariables
  353. >(GET_ORDERS_LIST, {
  354. options: {
  355. sort: {
  356. totalQuantity: SortOrder.DESC,
  357. },
  358. take: 10,
  359. },
  360. });
  361. expect(result.orders.items.map(o => pick(o, ['id', 'totalQuantity']))).toEqual([
  362. { id: 'T_2', totalQuantity: 4 },
  363. { id: 'T_1', totalQuantity: 2 },
  364. ]);
  365. });
  366. it('sort by customerLastName', async () => {
  367. async function sortOrdersByLastName(sortOrder: SortOrder) {
  368. const { orders } = await adminClient.query<
  369. Codegen.GetOrderListQuery,
  370. Codegen.GetOrderListQueryVariables
  371. >(GET_ORDERS_LIST, {
  372. options: {
  373. sort: {
  374. customerLastName: sortOrder,
  375. },
  376. },
  377. });
  378. return orders;
  379. }
  380. const result1 = await sortOrdersByLastName(SortOrder.ASC);
  381. expect(result1.totalItems).toEqual(2);
  382. expect(result1.items.map(order => order.customer?.lastName)).toEqual(['Donnelly', 'Zieme']);
  383. const result2 = await sortOrdersByLastName(SortOrder.DESC);
  384. expect(result2.totalItems).toEqual(2);
  385. expect(result2.items.map(order => order.customer?.lastName)).toEqual(['Zieme', 'Donnelly']);
  386. });
  387. it('filter by total', async () => {
  388. const result = await adminClient.query<
  389. Codegen.GetOrderListQuery,
  390. Codegen.GetOrderListQueryVariables
  391. >(GET_ORDERS_LIST, {
  392. options: {
  393. filter: {
  394. total: { gt: 323760 },
  395. },
  396. take: 10,
  397. },
  398. });
  399. expect(result.orders.items.map(o => pick(o, ['id', 'total']))).toEqual([
  400. { id: 'T_2', total: 799600 },
  401. ]);
  402. });
  403. it('filter by totalWithTax', async () => {
  404. const result = await adminClient.query<
  405. Codegen.GetOrderListQuery,
  406. Codegen.GetOrderListQueryVariables
  407. >(GET_ORDERS_LIST, {
  408. options: {
  409. filter: {
  410. totalWithTax: { gt: 323760 },
  411. },
  412. take: 10,
  413. },
  414. });
  415. expect(result.orders.items.map(o => pick(o, ['id', 'totalWithTax']))).toEqual([
  416. { id: 'T_2', totalWithTax: 959520 },
  417. ]);
  418. });
  419. it('filter by totalQuantity', async () => {
  420. const result = await adminClient.query<
  421. Codegen.GetOrderListQuery,
  422. Codegen.GetOrderListQueryVariables
  423. >(GET_ORDERS_LIST, {
  424. options: {
  425. filter: {
  426. totalQuantity: { eq: 4 },
  427. },
  428. },
  429. });
  430. expect(result.orders.items.map(o => pick(o, ['id', 'totalQuantity']))).toEqual([
  431. { id: 'T_2', totalQuantity: 4 },
  432. ]);
  433. });
  434. it('filter by customerLastName', async () => {
  435. const result = await adminClient.query<
  436. Codegen.GetOrderListQuery,
  437. Codegen.GetOrderListQueryVariables
  438. >(GET_ORDERS_LIST, {
  439. options: {
  440. filter: {
  441. customerLastName: {
  442. eq: customers[1].lastName,
  443. },
  444. },
  445. },
  446. });
  447. expect(result.orders.totalItems).toEqual(1);
  448. expect(result.orders.items[0].customer?.lastName).toEqual(customers[1].lastName);
  449. });
  450. });
  451. describe('payments', () => {
  452. let firstOrderCode: string;
  453. let firstOrderId: string;
  454. it('settlePayment fails', async () => {
  455. await shopClient.asUserWithCredentials(customers[0].emailAddress, password);
  456. await proceedToArrangingPayment(shopClient);
  457. const order = await addPaymentToOrder(shopClient, failsToSettlePaymentMethod);
  458. orderGuard.assertSuccess(order);
  459. expect(order.state).toBe('PaymentAuthorized');
  460. const payment = order.payments![0];
  461. const { settlePayment } = await adminClient.query<
  462. Codegen.SettlePaymentMutation,
  463. Codegen.SettlePaymentMutationVariables
  464. >(SETTLE_PAYMENT, {
  465. id: payment.id,
  466. });
  467. paymentGuard.assertErrorResult(settlePayment);
  468. expect(settlePayment.message).toBe('Settling the payment failed');
  469. expect(settlePayment.errorCode).toBe(ErrorCode.SETTLE_PAYMENT_ERROR);
  470. expect((settlePayment as any).paymentErrorMessage).toBe('Something went horribly wrong');
  471. const result = await adminClient.query<Codegen.GetOrderQuery, Codegen.GetOrderQueryVariables>(
  472. GET_ORDER,
  473. {
  474. id: order.id,
  475. },
  476. );
  477. expect(result.order!.state).toBe('PaymentAuthorized');
  478. expect(result.order!.payments![0].state).toBe('Cancelled');
  479. firstOrderCode = order.code;
  480. firstOrderId = order.id;
  481. });
  482. it('public payment metadata available in Shop API', async () => {
  483. const { orderByCode } = await shopClient.query<
  484. CodegenShop.GetOrderByCodeWithPaymentsQuery,
  485. CodegenShop.GetOrderByCodeWithPaymentsQueryVariables
  486. >(GET_ORDER_BY_CODE_WITH_PAYMENTS, { code: firstOrderCode });
  487. expect(orderByCode?.payments?.[0].metadata).toEqual({
  488. public: {
  489. publicCreatePaymentData: 'public',
  490. publicSettlePaymentData: 'public',
  491. },
  492. });
  493. });
  494. it('public and private payment metadata available in Admin API', async () => {
  495. const { order } = await adminClient.query<
  496. Codegen.GetOrderWithPaymentsQuery,
  497. Codegen.GetOrderWithPaymentsQueryVariables
  498. >(GET_ORDER_WITH_PAYMENTS, { id: firstOrderId });
  499. expect(order?.payments?.[0].metadata).toEqual({
  500. privateCreatePaymentData: 'secret',
  501. privateSettlePaymentData: 'secret',
  502. public: {
  503. publicCreatePaymentData: 'public',
  504. publicSettlePaymentData: 'public',
  505. },
  506. });
  507. });
  508. it('settlePayment succeeds, onStateTransitionStart called', async () => {
  509. onTransitionSpy.mockClear();
  510. await shopClient.asUserWithCredentials(customers[1].emailAddress, password);
  511. await proceedToArrangingPayment(shopClient);
  512. const order = await addPaymentToOrder(shopClient, twoStagePaymentMethod);
  513. orderGuard.assertSuccess(order);
  514. expect(order.state).toBe('PaymentAuthorized');
  515. expect(onTransitionSpy).toHaveBeenCalledTimes(1);
  516. expect(onTransitionSpy.mock.calls[0][0]).toBe('Created');
  517. expect(onTransitionSpy.mock.calls[0][1]).toBe('Authorized');
  518. const payment = order.payments![0];
  519. const { settlePayment } = await adminClient.query<
  520. Codegen.SettlePaymentMutation,
  521. Codegen.SettlePaymentMutationVariables
  522. >(SETTLE_PAYMENT, {
  523. id: payment.id,
  524. });
  525. paymentGuard.assertSuccess(settlePayment);
  526. expect(settlePayment.id).toBe(payment.id);
  527. expect(settlePayment.state).toBe('Settled');
  528. // further metadata is combined into existing object
  529. expect(settlePayment.metadata).toEqual({
  530. moreData: 42,
  531. public: {
  532. baz: 'quux',
  533. },
  534. });
  535. expect(onTransitionSpy).toHaveBeenCalledTimes(2);
  536. expect(onTransitionSpy.mock.calls[1][0]).toBe('Authorized');
  537. expect(onTransitionSpy.mock.calls[1][1]).toBe('Settled');
  538. const result = await adminClient.query<Codegen.GetOrderQuery, Codegen.GetOrderQueryVariables>(
  539. GET_ORDER,
  540. {
  541. id: order.id,
  542. },
  543. );
  544. expect(result.order!.state).toBe('PaymentSettled');
  545. expect(result.order!.payments![0].state).toBe('Settled');
  546. });
  547. it('order history contains expected entries', async () => {
  548. const { order } = await adminClient.query<
  549. Codegen.GetOrderHistoryQuery,
  550. Codegen.GetOrderHistoryQueryVariables
  551. >(GET_ORDER_HISTORY, { id: 'T_2', options: { sort: { id: SortOrder.ASC } } });
  552. expect(order.history.items.map(pick(['type', 'data']))).toEqual([
  553. {
  554. type: HistoryEntryType.ORDER_STATE_TRANSITION,
  555. data: {
  556. from: 'Created',
  557. to: 'AddingItems',
  558. },
  559. },
  560. {
  561. type: HistoryEntryType.ORDER_STATE_TRANSITION,
  562. data: {
  563. from: 'AddingItems',
  564. to: 'ArrangingPayment',
  565. },
  566. },
  567. {
  568. type: HistoryEntryType.ORDER_PAYMENT_TRANSITION,
  569. data: {
  570. paymentId: 'T_2',
  571. from: 'Created',
  572. to: 'Authorized',
  573. },
  574. },
  575. {
  576. type: HistoryEntryType.ORDER_STATE_TRANSITION,
  577. data: {
  578. from: 'ArrangingPayment',
  579. to: 'PaymentAuthorized',
  580. },
  581. },
  582. {
  583. type: HistoryEntryType.ORDER_PAYMENT_TRANSITION,
  584. data: {
  585. paymentId: 'T_2',
  586. from: 'Authorized',
  587. to: 'Settled',
  588. },
  589. },
  590. {
  591. type: HistoryEntryType.ORDER_STATE_TRANSITION,
  592. data: {
  593. from: 'PaymentAuthorized',
  594. to: 'PaymentSettled',
  595. },
  596. },
  597. ]);
  598. });
  599. it('filter by transactionId', async () => {
  600. const result = await adminClient.query<
  601. Codegen.GetOrderListQuery,
  602. Codegen.GetOrderListQueryVariables
  603. >(GET_ORDERS_LIST, {
  604. options: {
  605. filter: {
  606. transactionId: {
  607. eq: '12345-' + firstOrderCode,
  608. },
  609. },
  610. },
  611. });
  612. expect(result.orders.totalItems).toEqual(1);
  613. expect(result.orders.items[0].code).toBe(firstOrderCode);
  614. });
  615. });
  616. describe('fulfillment', () => {
  617. const orderId = 'T_2';
  618. let f1Id: string;
  619. let f2Id: string;
  620. let f3Id: string;
  621. it('return error result if lines is empty', async () => {
  622. const { order } = await adminClient.query<Codegen.GetOrderQuery, Codegen.GetOrderQueryVariables>(
  623. GET_ORDER,
  624. {
  625. id: orderId,
  626. },
  627. );
  628. expect(order!.state).toBe('PaymentSettled');
  629. const { addFulfillmentToOrder } = await adminClient.query<
  630. Codegen.CreateFulfillmentMutation,
  631. Codegen.CreateFulfillmentMutationVariables
  632. >(CREATE_FULFILLMENT, {
  633. input: {
  634. lines: [],
  635. handler: {
  636. code: manualFulfillmentHandler.code,
  637. arguments: [{ name: 'method', value: 'Test' }],
  638. },
  639. },
  640. });
  641. fulfillmentGuard.assertErrorResult(addFulfillmentToOrder);
  642. expect(addFulfillmentToOrder.message).toBe('At least one OrderLine must be specified');
  643. expect(addFulfillmentToOrder.errorCode).toBe(ErrorCode.EMPTY_ORDER_LINE_SELECTION_ERROR);
  644. });
  645. it('returns error result if all quantities are zero', async () => {
  646. const { order } = await adminClient.query<Codegen.GetOrderQuery, Codegen.GetOrderQueryVariables>(
  647. GET_ORDER,
  648. {
  649. id: orderId,
  650. },
  651. );
  652. expect(order!.state).toBe('PaymentSettled');
  653. const { addFulfillmentToOrder } = await adminClient.query<
  654. Codegen.CreateFulfillmentMutation,
  655. Codegen.CreateFulfillmentMutationVariables
  656. >(CREATE_FULFILLMENT, {
  657. input: {
  658. lines: order!.lines.map(l => ({ orderLineId: l.id, quantity: 0 })),
  659. handler: {
  660. code: manualFulfillmentHandler.code,
  661. arguments: [{ name: 'method', value: 'Test' }],
  662. },
  663. },
  664. });
  665. fulfillmentGuard.assertErrorResult(addFulfillmentToOrder);
  666. expect(addFulfillmentToOrder.message).toBe('At least one OrderLine must be specified');
  667. expect(addFulfillmentToOrder.errorCode).toBe(ErrorCode.EMPTY_ORDER_LINE_SELECTION_ERROR);
  668. });
  669. it('creates the first fulfillment', async () => {
  670. const { order } = await adminClient.query<Codegen.GetOrderQuery, Codegen.GetOrderQueryVariables>(
  671. GET_ORDER,
  672. {
  673. id: orderId,
  674. },
  675. );
  676. expect(order!.state).toBe('PaymentSettled');
  677. const lines = order!.lines;
  678. const { addFulfillmentToOrder } = await adminClient.query<
  679. Codegen.CreateFulfillmentMutation,
  680. Codegen.CreateFulfillmentMutationVariables
  681. >(CREATE_FULFILLMENT, {
  682. input: {
  683. lines: [{ orderLineId: lines[0].id, quantity: lines[0].quantity }],
  684. handler: {
  685. code: manualFulfillmentHandler.code,
  686. arguments: [
  687. { name: 'method', value: 'Test1' },
  688. { name: 'trackingCode', value: '111' },
  689. ],
  690. },
  691. },
  692. });
  693. fulfillmentGuard.assertSuccess(addFulfillmentToOrder);
  694. expect(addFulfillmentToOrder.id).toBe('T_1');
  695. expect(addFulfillmentToOrder.method).toBe('Test1');
  696. expect(addFulfillmentToOrder.trackingCode).toBe('111');
  697. expect(addFulfillmentToOrder.state).toBe('Pending');
  698. expect(addFulfillmentToOrder.lines).toEqual([
  699. { orderLineId: lines[0].id, quantity: lines[0].quantity },
  700. ]);
  701. f1Id = addFulfillmentToOrder.id;
  702. const result = await adminClient.query<Codegen.GetOrderQuery, Codegen.GetOrderQueryVariables>(
  703. GET_ORDER,
  704. {
  705. id: orderId,
  706. },
  707. );
  708. expect(result.order!.fulfillments?.length).toBe(1);
  709. expect(result.order!.fulfillments![0]!.id).toBe(addFulfillmentToOrder.id);
  710. expect(result.order!.fulfillments![0]!.lines).toEqual([
  711. {
  712. orderLineId: order?.lines[0].id,
  713. quantity: order?.lines[0].quantity,
  714. },
  715. ]);
  716. expect(
  717. result.order!.fulfillments![0]!.lines.filter(l => l.orderLineId === lines[1].id).length,
  718. ).toBe(0);
  719. });
  720. it('creates the second fulfillment', async () => {
  721. const lines = await getUnfulfilledOrderLineInput(adminClient, orderId);
  722. const { addFulfillmentToOrder } = await adminClient.query<
  723. Codegen.CreateFulfillmentMutation,
  724. Codegen.CreateFulfillmentMutationVariables
  725. >(CREATE_FULFILLMENT, {
  726. input: {
  727. lines,
  728. handler: {
  729. code: manualFulfillmentHandler.code,
  730. arguments: [
  731. { name: 'method', value: 'Test2' },
  732. { name: 'trackingCode', value: '222' },
  733. ],
  734. },
  735. },
  736. });
  737. fulfillmentGuard.assertSuccess(addFulfillmentToOrder);
  738. expect(addFulfillmentToOrder.id).toBe('T_2');
  739. expect(addFulfillmentToOrder.method).toBe('Test2');
  740. expect(addFulfillmentToOrder.trackingCode).toBe('222');
  741. expect(addFulfillmentToOrder.state).toBe('Pending');
  742. f2Id = addFulfillmentToOrder.id;
  743. });
  744. it('cancels second fulfillment', async () => {
  745. const { transitionFulfillmentToState } = await adminClient.query<
  746. Codegen.TransitFulfillmentMutation,
  747. Codegen.TransitFulfillmentMutationVariables
  748. >(TRANSIT_FULFILLMENT, {
  749. id: f2Id,
  750. state: 'Cancelled',
  751. });
  752. fulfillmentGuard.assertSuccess(transitionFulfillmentToState);
  753. expect(transitionFulfillmentToState.id).toBe('T_2');
  754. expect(transitionFulfillmentToState.state).toBe('Cancelled');
  755. });
  756. it('order.fulfillments still lists second (cancelled) fulfillment', async () => {
  757. const { order } = await adminClient.query<
  758. Codegen.GetOrderFulfillmentsQuery,
  759. Codegen.GetOrderFulfillmentsQueryVariables
  760. >(GET_ORDER_FULFILLMENTS, {
  761. id: orderId,
  762. });
  763. expect(order?.fulfillments?.sort(sortById).map(pick(['id', 'state']))).toEqual([
  764. { id: f1Id, state: 'Pending' },
  765. { id: f2Id, state: 'Cancelled' },
  766. ]);
  767. });
  768. it('order.fulfillments.summary', async () => {
  769. const { order } = await adminClient.query<
  770. Codegen.GetOrderFulfillmentsQuery,
  771. Codegen.GetOrderFulfillmentsQueryVariables
  772. >(GET_ORDER_FULFILLMENTS, {
  773. id: orderId,
  774. });
  775. expect(order?.fulfillments?.sort(sortById).map(pick(['id', 'state', 'summary']))).toEqual([
  776. { id: f1Id, state: 'Pending', summary: [{ orderLine: { id: 'T_3' }, quantity: 1 }] },
  777. { id: f2Id, state: 'Cancelled', summary: [{ orderLine: { id: 'T_4' }, quantity: 3 }] },
  778. ]);
  779. });
  780. it('lines.fulfillments', async () => {
  781. const { order } = await adminClient.query<
  782. Codegen.GetOrderLineFulfillmentsQuery,
  783. Codegen.GetOrderLineFulfillmentsQueryVariables
  784. >(GET_ORDER_LINE_FULFILLMENTS, {
  785. id: orderId,
  786. });
  787. expect(order?.lines.find(l => l.id === 'T_3')!.fulfillmentLines).toEqual([
  788. { fulfillment: { id: f1Id, state: 'Pending' }, orderLineId: 'T_3', quantity: 1 },
  789. ]);
  790. // Cancelled Fulfillments do not appear in the line field
  791. expect(order?.lines.find(l => l.id === 'T_4')!.fulfillmentLines).toEqual([]);
  792. });
  793. it('creates third fulfillment with same items from second fulfillment', async () => {
  794. const lines = await getUnfulfilledOrderLineInput(adminClient, orderId);
  795. const { addFulfillmentToOrder } = await adminClient.query<
  796. Codegen.CreateFulfillmentMutation,
  797. Codegen.CreateFulfillmentMutationVariables
  798. >(CREATE_FULFILLMENT, {
  799. input: {
  800. lines,
  801. handler: {
  802. code: manualFulfillmentHandler.code,
  803. arguments: [
  804. { name: 'method', value: 'Test3' },
  805. { name: 'trackingCode', value: '333' },
  806. ],
  807. },
  808. },
  809. });
  810. fulfillmentGuard.assertSuccess(addFulfillmentToOrder);
  811. expect(addFulfillmentToOrder.id).toBe('T_3');
  812. expect(addFulfillmentToOrder.method).toBe('Test3');
  813. expect(addFulfillmentToOrder.trackingCode).toBe('333');
  814. expect(addFulfillmentToOrder.state).toBe('Pending');
  815. f3Id = addFulfillmentToOrder.id;
  816. });
  817. it('returns error result if an OrderItem already part of a Fulfillment', async () => {
  818. const { order } = await adminClient.query<Codegen.GetOrderQuery, Codegen.GetOrderQueryVariables>(
  819. GET_ORDER,
  820. {
  821. id: orderId,
  822. },
  823. );
  824. const { addFulfillmentToOrder } = await adminClient.query<
  825. Codegen.CreateFulfillmentMutation,
  826. Codegen.CreateFulfillmentMutationVariables
  827. >(CREATE_FULFILLMENT, {
  828. input: {
  829. lines: [
  830. {
  831. orderLineId: order!.lines[0].id,
  832. quantity: 1,
  833. },
  834. ],
  835. handler: {
  836. code: manualFulfillmentHandler.code,
  837. arguments: [{ name: 'method', value: 'Test' }],
  838. },
  839. },
  840. });
  841. fulfillmentGuard.assertErrorResult(addFulfillmentToOrder);
  842. expect(addFulfillmentToOrder.message).toBe(
  843. 'One or more OrderItems are already part of a Fulfillment',
  844. );
  845. expect(addFulfillmentToOrder.errorCode).toBe(ErrorCode.ITEMS_ALREADY_FULFILLED_ERROR);
  846. });
  847. it('transitions the first fulfillment from created to Shipped and automatically change the order state to PartiallyShipped', async () => {
  848. const { transitionFulfillmentToState } = await adminClient.query<
  849. Codegen.TransitFulfillmentMutation,
  850. Codegen.TransitFulfillmentMutationVariables
  851. >(TRANSIT_FULFILLMENT, {
  852. id: f1Id,
  853. state: 'Shipped',
  854. });
  855. fulfillmentGuard.assertSuccess(transitionFulfillmentToState);
  856. expect(transitionFulfillmentToState.id).toBe(f1Id);
  857. expect(transitionFulfillmentToState.state).toBe('Shipped');
  858. const { order } = await adminClient.query<Codegen.GetOrderQuery, Codegen.GetOrderQueryVariables>(
  859. GET_ORDER,
  860. {
  861. id: orderId,
  862. },
  863. );
  864. expect(order?.state).toBe('PartiallyShipped');
  865. });
  866. it('transitions the third fulfillment from created to Shipped and automatically change the order state to Shipped', async () => {
  867. const { transitionFulfillmentToState } = await adminClient.query<
  868. Codegen.TransitFulfillmentMutation,
  869. Codegen.TransitFulfillmentMutationVariables
  870. >(TRANSIT_FULFILLMENT, {
  871. id: f3Id,
  872. state: 'Shipped',
  873. });
  874. fulfillmentGuard.assertSuccess(transitionFulfillmentToState);
  875. expect(transitionFulfillmentToState.id).toBe(f3Id);
  876. expect(transitionFulfillmentToState.state).toBe('Shipped');
  877. const { order } = await adminClient.query<Codegen.GetOrderQuery, Codegen.GetOrderQueryVariables>(
  878. GET_ORDER,
  879. {
  880. id: orderId,
  881. },
  882. );
  883. expect(order?.state).toBe('Shipped');
  884. });
  885. it('transitions the first fulfillment from Shipped to Delivered and change the order state to PartiallyDelivered', async () => {
  886. const { transitionFulfillmentToState } = await adminClient.query<
  887. Codegen.TransitFulfillmentMutation,
  888. Codegen.TransitFulfillmentMutationVariables
  889. >(TRANSIT_FULFILLMENT, {
  890. id: f1Id,
  891. state: 'Delivered',
  892. });
  893. fulfillmentGuard.assertSuccess(transitionFulfillmentToState);
  894. expect(transitionFulfillmentToState.id).toBe(f1Id);
  895. expect(transitionFulfillmentToState.state).toBe('Delivered');
  896. const { order } = await adminClient.query<Codegen.GetOrderQuery, Codegen.GetOrderQueryVariables>(
  897. GET_ORDER,
  898. {
  899. id: orderId,
  900. },
  901. );
  902. expect(order?.state).toBe('PartiallyDelivered');
  903. });
  904. it('transitions the third fulfillment from Shipped to Delivered and change the order state to Delivered', async () => {
  905. const { transitionFulfillmentToState } = await adminClient.query<
  906. Codegen.TransitFulfillmentMutation,
  907. Codegen.TransitFulfillmentMutationVariables
  908. >(TRANSIT_FULFILLMENT, {
  909. id: f3Id,
  910. state: 'Delivered',
  911. });
  912. fulfillmentGuard.assertSuccess(transitionFulfillmentToState);
  913. expect(transitionFulfillmentToState.id).toBe(f3Id);
  914. expect(transitionFulfillmentToState.state).toBe('Delivered');
  915. const { order } = await adminClient.query<Codegen.GetOrderQuery, Codegen.GetOrderQueryVariables>(
  916. GET_ORDER,
  917. {
  918. id: orderId,
  919. },
  920. );
  921. expect(order?.state).toBe('Delivered');
  922. });
  923. it('order history contains expected entries', async () => {
  924. const { order } = await adminClient.query<
  925. Codegen.GetOrderHistoryQuery,
  926. Codegen.GetOrderHistoryQueryVariables
  927. >(GET_ORDER_HISTORY, {
  928. id: orderId,
  929. options: {
  930. skip: 6,
  931. },
  932. });
  933. expect(order!.history.items.map(pick(['type', 'data']))).toEqual([
  934. {
  935. data: {
  936. fulfillmentId: f1Id,
  937. },
  938. type: HistoryEntryType.ORDER_FULFILLMENT,
  939. },
  940. {
  941. data: {
  942. from: 'Created',
  943. fulfillmentId: f1Id,
  944. to: 'Pending',
  945. },
  946. type: HistoryEntryType.ORDER_FULFILLMENT_TRANSITION,
  947. },
  948. {
  949. data: {
  950. fulfillmentId: f2Id,
  951. },
  952. type: HistoryEntryType.ORDER_FULFILLMENT,
  953. },
  954. {
  955. data: {
  956. from: 'Created',
  957. fulfillmentId: f2Id,
  958. to: 'Pending',
  959. },
  960. type: HistoryEntryType.ORDER_FULFILLMENT_TRANSITION,
  961. },
  962. {
  963. data: {
  964. from: 'Pending',
  965. fulfillmentId: f2Id,
  966. to: 'Cancelled',
  967. },
  968. type: HistoryEntryType.ORDER_FULFILLMENT_TRANSITION,
  969. },
  970. {
  971. data: {
  972. fulfillmentId: f3Id,
  973. },
  974. type: HistoryEntryType.ORDER_FULFILLMENT,
  975. },
  976. {
  977. data: {
  978. from: 'Created',
  979. fulfillmentId: f3Id,
  980. to: 'Pending',
  981. },
  982. type: HistoryEntryType.ORDER_FULFILLMENT_TRANSITION,
  983. },
  984. {
  985. data: {
  986. from: 'Pending',
  987. fulfillmentId: f1Id,
  988. to: 'Shipped',
  989. },
  990. type: HistoryEntryType.ORDER_FULFILLMENT_TRANSITION,
  991. },
  992. {
  993. data: {
  994. from: 'PaymentSettled',
  995. to: 'PartiallyShipped',
  996. },
  997. type: HistoryEntryType.ORDER_STATE_TRANSITION,
  998. },
  999. {
  1000. data: {
  1001. from: 'Pending',
  1002. fulfillmentId: f3Id,
  1003. to: 'Shipped',
  1004. },
  1005. type: HistoryEntryType.ORDER_FULFILLMENT_TRANSITION,
  1006. },
  1007. {
  1008. data: {
  1009. from: 'PartiallyShipped',
  1010. to: 'Shipped',
  1011. },
  1012. type: HistoryEntryType.ORDER_STATE_TRANSITION,
  1013. },
  1014. {
  1015. data: {
  1016. from: 'Shipped',
  1017. fulfillmentId: f1Id,
  1018. to: 'Delivered',
  1019. },
  1020. type: HistoryEntryType.ORDER_FULFILLMENT_TRANSITION,
  1021. },
  1022. {
  1023. data: {
  1024. from: 'Shipped',
  1025. to: 'PartiallyDelivered',
  1026. },
  1027. type: HistoryEntryType.ORDER_STATE_TRANSITION,
  1028. },
  1029. {
  1030. data: {
  1031. from: 'Shipped',
  1032. fulfillmentId: f3Id,
  1033. to: 'Delivered',
  1034. },
  1035. type: HistoryEntryType.ORDER_FULFILLMENT_TRANSITION,
  1036. },
  1037. {
  1038. data: {
  1039. from: 'PartiallyDelivered',
  1040. to: 'Delivered',
  1041. },
  1042. type: HistoryEntryType.ORDER_STATE_TRANSITION,
  1043. },
  1044. ]);
  1045. });
  1046. it('order.fulfillments resolver for single order', async () => {
  1047. const { order } = await adminClient.query<
  1048. Codegen.GetOrderFulfillmentsQuery,
  1049. Codegen.GetOrderFulfillmentsQueryVariables
  1050. >(GET_ORDER_FULFILLMENTS, {
  1051. id: orderId,
  1052. });
  1053. expect(
  1054. order!.fulfillments?.sort(sortById).map(pick(['id', 'method', 'state', 'nextStates'])),
  1055. ).toEqual([
  1056. { id: f1Id, method: 'Test1', state: 'Delivered', nextStates: ['Cancelled'] },
  1057. { id: f2Id, method: 'Test2', state: 'Cancelled', nextStates: [] },
  1058. { id: f3Id, method: 'Test3', state: 'Delivered', nextStates: ['Cancelled'] },
  1059. ]);
  1060. });
  1061. it('order.fulfillments resolver for order list', async () => {
  1062. const { orders } =
  1063. await adminClient.query<Codegen.GetOrderListFulfillmentsQuery>(GET_ORDER_LIST_FULFILLMENTS);
  1064. expect(orders.items[0].fulfillments).toEqual([]);
  1065. expect(orders.items[1].fulfillments?.sort(sortById)).toEqual([
  1066. { id: f1Id, method: 'Test1', state: 'Delivered', nextStates: ['Cancelled'] },
  1067. { id: f2Id, method: 'Test2', state: 'Cancelled', nextStates: [] },
  1068. { id: f3Id, method: 'Test3', state: 'Delivered', nextStates: ['Cancelled'] },
  1069. ]);
  1070. });
  1071. });
  1072. describe('cancellation by orderId', () => {
  1073. it('cancel from AddingItems state', async () => {
  1074. const testOrder = await createTestOrder(
  1075. adminClient,
  1076. shopClient,
  1077. customers[0].emailAddress,
  1078. password,
  1079. );
  1080. const { order } = await adminClient.query<Codegen.GetOrderQuery, Codegen.GetOrderQueryVariables>(
  1081. GET_ORDER,
  1082. {
  1083. id: testOrder.orderId,
  1084. },
  1085. );
  1086. expect(order!.state).toBe('AddingItems');
  1087. const { cancelOrder } = await adminClient.query<
  1088. Codegen.CancelOrderMutation,
  1089. Codegen.CancelOrderMutationVariables
  1090. >(CANCEL_ORDER, {
  1091. input: {
  1092. orderId: testOrder.orderId,
  1093. },
  1094. });
  1095. const { order: order2 } = await adminClient.query<
  1096. Codegen.GetOrderQuery,
  1097. Codegen.GetOrderQueryVariables
  1098. >(GET_ORDER, {
  1099. id: testOrder.orderId,
  1100. });
  1101. expect(order2!.state).toBe('Cancelled');
  1102. expect(order2!.active).toBe(false);
  1103. await assertNoStockMovementsCreated(testOrder.product!.id);
  1104. });
  1105. it('cancel from ArrangingPayment state', async () => {
  1106. const testOrder = await createTestOrder(
  1107. adminClient,
  1108. shopClient,
  1109. customers[0].emailAddress,
  1110. password,
  1111. );
  1112. await proceedToArrangingPayment(shopClient);
  1113. const { order } = await adminClient.query<Codegen.GetOrderQuery, Codegen.GetOrderQueryVariables>(
  1114. GET_ORDER,
  1115. {
  1116. id: testOrder.orderId,
  1117. },
  1118. );
  1119. expect(order!.state).toBe('ArrangingPayment');
  1120. await adminClient.query<Codegen.CancelOrderMutation, Codegen.CancelOrderMutationVariables>(
  1121. CANCEL_ORDER,
  1122. {
  1123. input: {
  1124. orderId: testOrder.orderId,
  1125. },
  1126. },
  1127. );
  1128. const { order: order2 } = await adminClient.query<
  1129. Codegen.GetOrderQuery,
  1130. Codegen.GetOrderQueryVariables
  1131. >(GET_ORDER, {
  1132. id: testOrder.orderId,
  1133. });
  1134. expect(order2!.state).toBe('Cancelled');
  1135. expect(order2!.active).toBe(false);
  1136. await assertNoStockMovementsCreated(testOrder.product!.id);
  1137. });
  1138. it('cancel from PaymentAuthorized state with cancelShipping: true', async () => {
  1139. const testOrder = await createTestOrder(
  1140. adminClient,
  1141. shopClient,
  1142. customers[0].emailAddress,
  1143. password,
  1144. );
  1145. await proceedToArrangingPayment(shopClient, 2);
  1146. const order = await addPaymentToOrder(shopClient, failsToSettlePaymentMethod);
  1147. orderGuard.assertSuccess(order);
  1148. expect(order.state).toBe('PaymentAuthorized');
  1149. const result1 = await adminClient.query<
  1150. Codegen.GetStockMovementQuery,
  1151. Codegen.GetStockMovementQueryVariables
  1152. >(GET_STOCK_MOVEMENT, {
  1153. id: 'T_3',
  1154. });
  1155. let variant1 = result1.product!.variants[0];
  1156. expect(variant1.stockOnHand).toBe(100);
  1157. expect(variant1.stockAllocated).toBe(2);
  1158. expect(variant1.stockMovements.items.map(pick(['type', 'quantity']))).toEqual([
  1159. { type: StockMovementType.ADJUSTMENT, quantity: 100 },
  1160. { type: StockMovementType.ALLOCATION, quantity: 2 },
  1161. ]);
  1162. const { cancelOrder } = await adminClient.query<
  1163. Codegen.CancelOrderMutation,
  1164. Codegen.CancelOrderMutationVariables
  1165. >(CANCEL_ORDER, {
  1166. input: {
  1167. orderId: testOrder.orderId,
  1168. cancelShipping: true,
  1169. },
  1170. });
  1171. orderGuard.assertSuccess(cancelOrder);
  1172. expect(cancelOrder.lines.sort((a, b) => (a.id > b.id ? 1 : -1))).toEqual([
  1173. { id: 'T_7', quantity: 0 },
  1174. ]);
  1175. const { order: order2 } = await adminClient.query<
  1176. Codegen.GetOrderQuery,
  1177. Codegen.GetOrderQueryVariables
  1178. >(GET_ORDER, {
  1179. id: testOrder.orderId,
  1180. });
  1181. expect(order2!.active).toBe(false);
  1182. expect(order2!.state).toBe('Cancelled');
  1183. expect(order2!.totalWithTax).toBe(0);
  1184. expect(order2!.shippingWithTax).toBe(0);
  1185. const result2 = await adminClient.query<
  1186. Codegen.GetStockMovementQuery,
  1187. Codegen.GetStockMovementQueryVariables
  1188. >(GET_STOCK_MOVEMENT, {
  1189. id: 'T_3',
  1190. });
  1191. variant1 = result2.product!.variants[0];
  1192. expect(variant1.stockOnHand).toBe(100);
  1193. expect(variant1.stockAllocated).toBe(0);
  1194. expect(variant1.stockMovements.items.map(pick(['type', 'quantity']))).toEqual([
  1195. { type: StockMovementType.ADJUSTMENT, quantity: 100 },
  1196. { type: StockMovementType.ALLOCATION, quantity: 2 },
  1197. { type: StockMovementType.RELEASE, quantity: 2 },
  1198. ]);
  1199. });
  1200. async function assertNoStockMovementsCreated(productId: string) {
  1201. const result = await adminClient.query<
  1202. Codegen.GetStockMovementQuery,
  1203. Codegen.GetStockMovementQueryVariables
  1204. >(GET_STOCK_MOVEMENT, {
  1205. id: productId,
  1206. });
  1207. const variant2 = result.product!.variants[0];
  1208. expect(variant2.stockOnHand).toBe(100);
  1209. expect(variant2.stockMovements.items.map(pick(['type', 'quantity']))).toEqual([
  1210. { type: StockMovementType.ADJUSTMENT, quantity: 100 },
  1211. ]);
  1212. }
  1213. });
  1214. describe('cancellation by OrderLine', () => {
  1215. let orderId: string;
  1216. let product: Codegen.GetProductWithVariantsQuery['product'];
  1217. let productVariantId: string;
  1218. beforeAll(async () => {
  1219. const result = await createTestOrder(
  1220. adminClient,
  1221. shopClient,
  1222. customers[0].emailAddress,
  1223. password,
  1224. );
  1225. orderId = result.orderId;
  1226. product = result.product;
  1227. productVariantId = result.productVariantId;
  1228. });
  1229. it('cannot cancel from AddingItems state', async () => {
  1230. const { order } = await adminClient.query<Codegen.GetOrderQuery, Codegen.GetOrderQueryVariables>(
  1231. GET_ORDER,
  1232. {
  1233. id: orderId,
  1234. },
  1235. );
  1236. expect(order!.state).toBe('AddingItems');
  1237. const { cancelOrder } = await adminClient.query<
  1238. Codegen.CancelOrderMutation,
  1239. Codegen.CancelOrderMutationVariables
  1240. >(CANCEL_ORDER, {
  1241. input: {
  1242. orderId,
  1243. lines: order!.lines.map(l => ({ orderLineId: l.id, quantity: 1 })),
  1244. },
  1245. });
  1246. orderGuard.assertErrorResult(cancelOrder);
  1247. expect(cancelOrder.message).toBe(
  1248. 'Cannot cancel OrderLines from an Order in the "AddingItems" state',
  1249. );
  1250. expect(cancelOrder.errorCode).toBe(ErrorCode.CANCEL_ACTIVE_ORDER_ERROR);
  1251. });
  1252. it('cannot cancel from ArrangingPayment state', async () => {
  1253. await proceedToArrangingPayment(shopClient, 2);
  1254. const { order } = await adminClient.query<Codegen.GetOrderQuery, Codegen.GetOrderQueryVariables>(
  1255. GET_ORDER,
  1256. {
  1257. id: orderId,
  1258. },
  1259. );
  1260. expect(order!.state).toBe('ArrangingPayment');
  1261. const { cancelOrder } = await adminClient.query<
  1262. Codegen.CancelOrderMutation,
  1263. Codegen.CancelOrderMutationVariables
  1264. >(CANCEL_ORDER, {
  1265. input: {
  1266. orderId,
  1267. lines: order!.lines.map(l => ({ orderLineId: l.id, quantity: 1 })),
  1268. },
  1269. });
  1270. orderGuard.assertErrorResult(cancelOrder);
  1271. expect(cancelOrder.message).toBe(
  1272. 'Cannot cancel OrderLines from an Order in the "ArrangingPayment" state',
  1273. );
  1274. expect(cancelOrder.errorCode).toBe(ErrorCode.CANCEL_ACTIVE_ORDER_ERROR);
  1275. });
  1276. it('returns error result if lines are empty', async () => {
  1277. const order = await addPaymentToOrder(shopClient, twoStagePaymentMethod);
  1278. orderGuard.assertSuccess(order);
  1279. expect(order.state).toBe('PaymentAuthorized');
  1280. const { cancelOrder } = await adminClient.query<
  1281. Codegen.CancelOrderMutation,
  1282. Codegen.CancelOrderMutationVariables
  1283. >(CANCEL_ORDER, {
  1284. input: {
  1285. orderId,
  1286. lines: [],
  1287. },
  1288. });
  1289. orderGuard.assertErrorResult(cancelOrder);
  1290. expect(cancelOrder.message).toBe('At least one OrderLine must be specified');
  1291. expect(cancelOrder.errorCode).toBe(ErrorCode.EMPTY_ORDER_LINE_SELECTION_ERROR);
  1292. });
  1293. it('returns error result if all quantities zero', async () => {
  1294. const { order } = await adminClient.query<Codegen.GetOrderQuery, Codegen.GetOrderQueryVariables>(
  1295. GET_ORDER,
  1296. {
  1297. id: orderId,
  1298. },
  1299. );
  1300. const { cancelOrder } = await adminClient.query<
  1301. Codegen.CancelOrderMutation,
  1302. Codegen.CancelOrderMutationVariables
  1303. >(CANCEL_ORDER, {
  1304. input: {
  1305. orderId,
  1306. lines: order!.lines.map(l => ({ orderLineId: l.id, quantity: 0 })),
  1307. },
  1308. });
  1309. orderGuard.assertErrorResult(cancelOrder);
  1310. expect(cancelOrder.message).toBe('At least one OrderLine must be specified');
  1311. expect(cancelOrder.errorCode).toBe(ErrorCode.EMPTY_ORDER_LINE_SELECTION_ERROR);
  1312. });
  1313. it('partial cancellation', async () => {
  1314. const result1 = await adminClient.query<
  1315. Codegen.GetStockMovementQuery,
  1316. Codegen.GetStockMovementQueryVariables
  1317. >(GET_STOCK_MOVEMENT, {
  1318. id: product!.id,
  1319. });
  1320. const variant1 = result1.product!.variants[0];
  1321. expect(variant1.stockOnHand).toBe(100);
  1322. expect(variant1.stockAllocated).toBe(2);
  1323. expect(variant1.stockMovements.items.map(pick(['type', 'quantity']))).toEqual([
  1324. { type: StockMovementType.ADJUSTMENT, quantity: 100 },
  1325. { type: StockMovementType.ALLOCATION, quantity: 2 },
  1326. { type: StockMovementType.RELEASE, quantity: 2 },
  1327. { type: StockMovementType.ALLOCATION, quantity: 2 },
  1328. ]);
  1329. const { order } = await adminClient.query<Codegen.GetOrderQuery, Codegen.GetOrderQueryVariables>(
  1330. GET_ORDER,
  1331. {
  1332. id: orderId,
  1333. },
  1334. );
  1335. const { cancelOrder } = await adminClient.query<
  1336. Codegen.CancelOrderMutation,
  1337. Codegen.CancelOrderMutationVariables
  1338. >(CANCEL_ORDER, {
  1339. input: {
  1340. orderId,
  1341. lines: order!.lines.map(l => ({ orderLineId: l.id, quantity: 1 })),
  1342. reason: 'cancel reason 1',
  1343. },
  1344. });
  1345. orderGuard.assertSuccess(cancelOrder);
  1346. expect(cancelOrder.lines[0].quantity).toBe(1);
  1347. const { order: order2 } = await adminClient.query<
  1348. Codegen.GetOrderQuery,
  1349. Codegen.GetOrderQueryVariables
  1350. >(GET_ORDER, {
  1351. id: orderId,
  1352. });
  1353. expect(order2!.state).toBe('PaymentAuthorized');
  1354. expect(order2!.lines[0].quantity).toBe(1);
  1355. const result2 = await adminClient.query<
  1356. Codegen.GetStockMovementQuery,
  1357. Codegen.GetStockMovementQueryVariables
  1358. >(GET_STOCK_MOVEMENT, {
  1359. id: product!.id,
  1360. });
  1361. const variant2 = result2.product!.variants[0];
  1362. expect(variant2.stockOnHand).toBe(100);
  1363. expect(variant2.stockAllocated).toBe(1);
  1364. expect(variant2.stockMovements.items.map(pick(['type', 'quantity']))).toEqual([
  1365. { type: StockMovementType.ADJUSTMENT, quantity: 100 },
  1366. { type: StockMovementType.ALLOCATION, quantity: 2 },
  1367. { type: StockMovementType.RELEASE, quantity: 2 },
  1368. { type: StockMovementType.ALLOCATION, quantity: 2 },
  1369. { type: StockMovementType.RELEASE, quantity: 1 },
  1370. ]);
  1371. });
  1372. it('returns error result if attempting to cancel already cancelled item', async () => {
  1373. const { order } = await adminClient.query<Codegen.GetOrderQuery, Codegen.GetOrderQueryVariables>(
  1374. GET_ORDER,
  1375. {
  1376. id: orderId,
  1377. },
  1378. );
  1379. const { cancelOrder } = await adminClient.query<
  1380. Codegen.CancelOrderMutation,
  1381. Codegen.CancelOrderMutationVariables
  1382. >(CANCEL_ORDER, {
  1383. input: {
  1384. orderId,
  1385. lines: order!.lines.map(l => ({ orderLineId: l.id, quantity: 2 })),
  1386. },
  1387. });
  1388. orderGuard.assertErrorResult(cancelOrder);
  1389. expect(cancelOrder.message).toBe(
  1390. 'The specified quantity is greater than the available OrderItems',
  1391. );
  1392. expect(cancelOrder.errorCode).toBe(ErrorCode.QUANTITY_TOO_GREAT_ERROR);
  1393. });
  1394. it('complete cancellation', async () => {
  1395. const { order } = await adminClient.query<Codegen.GetOrderQuery, Codegen.GetOrderQueryVariables>(
  1396. GET_ORDER,
  1397. {
  1398. id: orderId,
  1399. },
  1400. );
  1401. await adminClient.query<Codegen.CancelOrderMutation, Codegen.CancelOrderMutationVariables>(
  1402. CANCEL_ORDER,
  1403. {
  1404. input: {
  1405. orderId,
  1406. lines: order!.lines.map(l => ({ orderLineId: l.id, quantity: 1 })),
  1407. reason: 'cancel reason 2',
  1408. cancelShipping: true,
  1409. },
  1410. },
  1411. );
  1412. const { order: order2 } = await adminClient.query<
  1413. Codegen.GetOrderQuery,
  1414. Codegen.GetOrderQueryVariables
  1415. >(GET_ORDER, {
  1416. id: orderId,
  1417. });
  1418. expect(order2!.state).toBe('Cancelled');
  1419. expect(order2!.shippingWithTax).toBe(0);
  1420. expect(order2!.totalWithTax).toBe(0);
  1421. const result = await adminClient.query<
  1422. Codegen.GetStockMovementQuery,
  1423. Codegen.GetStockMovementQueryVariables
  1424. >(GET_STOCK_MOVEMENT, {
  1425. id: product!.id,
  1426. });
  1427. const variant2 = result.product!.variants[0];
  1428. expect(variant2.stockOnHand).toBe(100);
  1429. expect(variant2.stockAllocated).toBe(0);
  1430. expect(variant2.stockMovements.items.map(pick(['type', 'quantity']))).toEqual([
  1431. { type: StockMovementType.ADJUSTMENT, quantity: 100 },
  1432. { type: StockMovementType.ALLOCATION, quantity: 2 },
  1433. { type: StockMovementType.RELEASE, quantity: 2 },
  1434. { type: StockMovementType.ALLOCATION, quantity: 2 },
  1435. { type: StockMovementType.RELEASE, quantity: 1 },
  1436. { type: StockMovementType.RELEASE, quantity: 1 },
  1437. ]);
  1438. });
  1439. it('cancelled OrderLine.unitPrice is not zero', async () => {
  1440. const { order } = await adminClient.query<Codegen.GetOrderQuery, Codegen.GetOrderQueryVariables>(
  1441. GET_ORDER,
  1442. {
  1443. id: orderId,
  1444. },
  1445. );
  1446. expect(order?.lines[0].unitPrice).not.toBe(0);
  1447. });
  1448. it('order history contains expected entries', async () => {
  1449. const { order } = await adminClient.query<
  1450. Codegen.GetOrderHistoryQuery,
  1451. Codegen.GetOrderHistoryQueryVariables
  1452. >(GET_ORDER_HISTORY, {
  1453. id: orderId,
  1454. options: {
  1455. skip: 0,
  1456. },
  1457. });
  1458. expect(order!.history.items.map(pick(['type', 'data']))).toEqual([
  1459. {
  1460. type: HistoryEntryType.ORDER_STATE_TRANSITION,
  1461. data: {
  1462. from: 'Created',
  1463. to: 'AddingItems',
  1464. },
  1465. },
  1466. {
  1467. type: HistoryEntryType.ORDER_STATE_TRANSITION,
  1468. data: {
  1469. from: 'AddingItems',
  1470. to: 'ArrangingPayment',
  1471. },
  1472. },
  1473. {
  1474. type: HistoryEntryType.ORDER_PAYMENT_TRANSITION,
  1475. data: {
  1476. paymentId: 'T_4',
  1477. from: 'Created',
  1478. to: 'Authorized',
  1479. },
  1480. },
  1481. {
  1482. type: HistoryEntryType.ORDER_STATE_TRANSITION,
  1483. data: {
  1484. from: 'ArrangingPayment',
  1485. to: 'PaymentAuthorized',
  1486. },
  1487. },
  1488. {
  1489. type: HistoryEntryType.ORDER_CANCELLATION,
  1490. data: {
  1491. lines: [{ orderLineId: 'T_8', quantity: 1 }],
  1492. reason: 'cancel reason 1',
  1493. shippingCancelled: false,
  1494. },
  1495. },
  1496. {
  1497. type: HistoryEntryType.ORDER_CANCELLATION,
  1498. data: {
  1499. lines: [{ orderLineId: 'T_8', quantity: 1 }],
  1500. reason: 'cancel reason 2',
  1501. shippingCancelled: true,
  1502. },
  1503. },
  1504. {
  1505. type: HistoryEntryType.ORDER_STATE_TRANSITION,
  1506. data: {
  1507. from: 'PaymentAuthorized',
  1508. to: 'Cancelled',
  1509. },
  1510. },
  1511. ]);
  1512. });
  1513. });
  1514. describe('refunds', () => {
  1515. let orderId: string;
  1516. let paymentId: string;
  1517. let refundId: string;
  1518. beforeAll(async () => {
  1519. const result = await createTestOrder(
  1520. adminClient,
  1521. shopClient,
  1522. customers[0].emailAddress,
  1523. password,
  1524. );
  1525. orderId = result.orderId;
  1526. });
  1527. it('cannot refund from PaymentAuthorized state', async () => {
  1528. await proceedToArrangingPayment(shopClient);
  1529. const order = await addPaymentToOrder(shopClient, twoStagePaymentMethod);
  1530. orderGuard.assertSuccess(order);
  1531. expect(order.state).toBe('PaymentAuthorized');
  1532. paymentId = order.payments![0].id;
  1533. const { refundOrder } = await adminClient.query<
  1534. Codegen.RefundOrderMutation,
  1535. Codegen.RefundOrderMutationVariables
  1536. >(REFUND_ORDER, {
  1537. input: {
  1538. lines: order.lines.map(l => ({ orderLineId: l.id, quantity: 1 })),
  1539. shipping: 0,
  1540. adjustment: 0,
  1541. paymentId,
  1542. },
  1543. });
  1544. refundGuard.assertErrorResult(refundOrder);
  1545. expect(refundOrder.message).toBe('Cannot refund an Order in the "PaymentAuthorized" state');
  1546. expect(refundOrder.errorCode).toBe(ErrorCode.REFUND_ORDER_STATE_ERROR);
  1547. });
  1548. it('returns error result if no amount and no shipping', async () => {
  1549. const { order } = await adminClient.query<Codegen.GetOrderQuery, Codegen.GetOrderQueryVariables>(
  1550. GET_ORDER,
  1551. {
  1552. id: orderId,
  1553. },
  1554. );
  1555. const { settlePayment } = await adminClient.query<
  1556. Codegen.SettlePaymentMutation,
  1557. Codegen.SettlePaymentMutationVariables
  1558. >(SETTLE_PAYMENT, {
  1559. id: order!.payments![0].id,
  1560. });
  1561. paymentGuard.assertSuccess(settlePayment);
  1562. expect(settlePayment.state).toBe('Settled');
  1563. const { refundOrder } = await adminClient.query<
  1564. Codegen.RefundOrderMutation,
  1565. Codegen.RefundOrderMutationVariables
  1566. >(REFUND_ORDER, {
  1567. input: {
  1568. lines: order!.lines.map(l => ({ orderLineId: l.id, quantity: 0 })),
  1569. shipping: 0,
  1570. adjustment: 0,
  1571. paymentId,
  1572. },
  1573. });
  1574. refundGuard.assertErrorResult(refundOrder);
  1575. expect(refundOrder.message).toBe('Nothing to refund');
  1576. expect(refundOrder.errorCode).toBe(ErrorCode.NOTHING_TO_REFUND_ERROR);
  1577. });
  1578. it(
  1579. 'throws if paymentId not valid',
  1580. assertThrowsWithMessage(async () => {
  1581. const { order } = await adminClient.query<
  1582. Codegen.GetOrderQuery,
  1583. Codegen.GetOrderQueryVariables
  1584. >(GET_ORDER, {
  1585. id: orderId,
  1586. });
  1587. const { refundOrder } = await adminClient.query<
  1588. Codegen.RefundOrderMutation,
  1589. Codegen.RefundOrderMutationVariables
  1590. >(REFUND_ORDER, {
  1591. input: {
  1592. lines: [],
  1593. shipping: 100,
  1594. adjustment: 0,
  1595. paymentId: 'T_999',
  1596. },
  1597. });
  1598. }, 'No Payment with the id "999" could be found'),
  1599. );
  1600. it('returns error result if payment and order lines do not belong to the same Order', async () => {
  1601. const { order } = await adminClient.query<Codegen.GetOrderQuery, Codegen.GetOrderQueryVariables>(
  1602. GET_ORDER,
  1603. {
  1604. id: orderId,
  1605. },
  1606. );
  1607. const { refundOrder } = await adminClient.query<
  1608. Codegen.RefundOrderMutation,
  1609. Codegen.RefundOrderMutationVariables
  1610. >(REFUND_ORDER, {
  1611. input: {
  1612. lines: order!.lines.map(l => ({ orderLineId: l.id, quantity: l.quantity })),
  1613. shipping: 100,
  1614. adjustment: 0,
  1615. paymentId: 'T_1',
  1616. },
  1617. });
  1618. refundGuard.assertErrorResult(refundOrder);
  1619. expect(refundOrder.message).toBe('The Payment and OrderLines do not belong to the same Order');
  1620. expect(refundOrder.errorCode).toBe(ErrorCode.PAYMENT_ORDER_MISMATCH_ERROR);
  1621. });
  1622. it('creates a Refund to be manually settled', async () => {
  1623. const { order } = await adminClient.query<Codegen.GetOrderQuery, Codegen.GetOrderQueryVariables>(
  1624. GET_ORDER,
  1625. {
  1626. id: orderId,
  1627. },
  1628. );
  1629. const { refundOrder } = await adminClient.query<
  1630. Codegen.RefundOrderMutation,
  1631. Codegen.RefundOrderMutationVariables
  1632. >(REFUND_ORDER, {
  1633. input: {
  1634. lines: order!.lines.map(l => ({ orderLineId: l.id, quantity: l.quantity })),
  1635. shipping: order!.shippingWithTax,
  1636. adjustment: 0,
  1637. reason: 'foo',
  1638. paymentId,
  1639. },
  1640. });
  1641. refundGuard.assertSuccess(refundOrder);
  1642. expect(refundOrder.shipping).toBe(order!.shippingWithTax);
  1643. expect(refundOrder.items).toBe(order!.subTotalWithTax);
  1644. expect(refundOrder.total).toBe(order!.totalWithTax);
  1645. expect(refundOrder.transactionId).toBe(null);
  1646. expect(refundOrder.state).toBe('Pending');
  1647. refundId = refundOrder.id;
  1648. });
  1649. it('manually settle a Refund', async () => {
  1650. const { settleRefund } = await adminClient.query<
  1651. Codegen.SettleRefundMutation,
  1652. Codegen.SettleRefundMutationVariables
  1653. >(SETTLE_REFUND, {
  1654. input: {
  1655. id: refundId,
  1656. transactionId: 'aaabbb',
  1657. },
  1658. });
  1659. refundGuard.assertSuccess(settleRefund);
  1660. expect(settleRefund.state).toBe('Settled');
  1661. expect(settleRefund.transactionId).toBe('aaabbb');
  1662. });
  1663. it('order history contains expected entries', async () => {
  1664. const { order } = await adminClient.query<
  1665. Codegen.GetOrderHistoryQuery,
  1666. Codegen.GetOrderHistoryQueryVariables
  1667. >(GET_ORDER_HISTORY, {
  1668. id: orderId,
  1669. options: {
  1670. skip: 0,
  1671. },
  1672. });
  1673. expect(order!.history.items.sort(sortById).map(pick(['type', 'data']))).toEqual([
  1674. {
  1675. type: HistoryEntryType.ORDER_STATE_TRANSITION,
  1676. data: {
  1677. from: 'Created',
  1678. to: 'AddingItems',
  1679. },
  1680. },
  1681. {
  1682. type: HistoryEntryType.ORDER_STATE_TRANSITION,
  1683. data: {
  1684. from: 'AddingItems',
  1685. to: 'ArrangingPayment',
  1686. },
  1687. },
  1688. {
  1689. type: HistoryEntryType.ORDER_PAYMENT_TRANSITION,
  1690. data: {
  1691. paymentId: 'T_5',
  1692. from: 'Created',
  1693. to: 'Authorized',
  1694. },
  1695. },
  1696. {
  1697. type: HistoryEntryType.ORDER_STATE_TRANSITION,
  1698. data: {
  1699. from: 'ArrangingPayment',
  1700. to: 'PaymentAuthorized',
  1701. },
  1702. },
  1703. {
  1704. type: HistoryEntryType.ORDER_PAYMENT_TRANSITION,
  1705. data: {
  1706. paymentId: 'T_5',
  1707. from: 'Authorized',
  1708. to: 'Settled',
  1709. },
  1710. },
  1711. {
  1712. type: HistoryEntryType.ORDER_STATE_TRANSITION,
  1713. data: {
  1714. from: 'PaymentAuthorized',
  1715. to: 'PaymentSettled',
  1716. },
  1717. },
  1718. {
  1719. type: HistoryEntryType.ORDER_REFUND_TRANSITION,
  1720. data: {
  1721. refundId: 'T_1',
  1722. reason: 'foo',
  1723. from: 'Pending',
  1724. to: 'Settled',
  1725. },
  1726. },
  1727. ]);
  1728. });
  1729. // https://github.com/vendurehq/vendure/issues/873
  1730. it('can add another refund if the first one fails', async () => {
  1731. const orderResult = await createTestOrder(
  1732. adminClient,
  1733. shopClient,
  1734. customers[0].emailAddress,
  1735. password,
  1736. );
  1737. await proceedToArrangingPayment(shopClient, 2);
  1738. const order = await addPaymentToOrder(shopClient, singleStageRefundFailingPaymentMethod);
  1739. orderGuard.assertSuccess(order);
  1740. expect(order.state).toBe('PaymentSettled');
  1741. const { refundOrder: refund1 } = await adminClient.query<
  1742. Codegen.RefundOrderMutation,
  1743. Codegen.RefundOrderMutationVariables
  1744. >(REFUND_ORDER, {
  1745. input: {
  1746. lines: order.lines.map(l => ({ orderLineId: l.id, quantity: l.quantity })),
  1747. shipping: order.shippingWithTax,
  1748. adjustment: 0,
  1749. reason: 'foo',
  1750. paymentId: order.payments![0].id,
  1751. },
  1752. });
  1753. refundGuard.assertSuccess(refund1);
  1754. expect(refund1.state).toBe('Failed');
  1755. expect(refund1.total).toBe(order.totalWithTax);
  1756. const { refundOrder: refund2 } = await adminClient.query<
  1757. Codegen.RefundOrderMutation,
  1758. Codegen.RefundOrderMutationVariables
  1759. >(REFUND_ORDER, {
  1760. input: {
  1761. lines: order.lines.map(l => ({ orderLineId: l.id, quantity: l.quantity })),
  1762. shipping: order.shippingWithTax,
  1763. adjustment: 0,
  1764. reason: 'foo',
  1765. paymentId: order.payments![0].id,
  1766. },
  1767. });
  1768. refundGuard.assertSuccess(refund2);
  1769. expect(refund2.state).toBe('Settled');
  1770. expect(refund2.total).toBe(order.totalWithTax);
  1771. });
  1772. // https://github.com/vendurehq/vendure/issues/2302
  1773. it('passes correct amount to createRefund function after cancellation', async () => {
  1774. const orderResult = await createTestOrder(
  1775. adminClient,
  1776. shopClient,
  1777. customers[0].emailAddress,
  1778. password,
  1779. );
  1780. await proceedToArrangingPayment(shopClient, 2);
  1781. const order = await addPaymentToOrder(shopClient, singleStageRefundablePaymentMethod);
  1782. orderGuard.assertSuccess(order);
  1783. expect(order.state).toBe('PaymentSettled');
  1784. const { cancelOrder } = await adminClient.query<
  1785. Codegen.CancelOrderMutation,
  1786. Codegen.CancelOrderMutationVariables
  1787. >(CANCEL_ORDER, {
  1788. input: {
  1789. orderId: order.id,
  1790. lines: order.lines.map(l => ({ orderLineId: l.id, quantity: l.quantity })),
  1791. reason: 'cancel reason 1',
  1792. },
  1793. });
  1794. orderGuard.assertSuccess(cancelOrder);
  1795. const { refundOrder } = await adminClient.query<
  1796. Codegen.RefundOrderMutation,
  1797. Codegen.RefundOrderMutationVariables
  1798. >(REFUND_ORDER, {
  1799. input: {
  1800. lines: order.lines.map(l => ({ orderLineId: l.id, quantity: l.quantity })),
  1801. shipping: order.shippingWithTax,
  1802. adjustment: 0,
  1803. reason: 'foo',
  1804. paymentId: order.payments![0].id,
  1805. },
  1806. });
  1807. refundGuard.assertSuccess(refundOrder);
  1808. expect(refundOrder.state).toBe('Settled');
  1809. expect(refundOrder.total).toBe(order.totalWithTax);
  1810. expect(refundOrder.metadata.amount).toBe(order.totalWithTax);
  1811. });
  1812. });
  1813. describe('payment cancellation', () => {
  1814. it("cancelling payment calls the method's cancelPayment handler", async () => {
  1815. await createTestOrder(adminClient, shopClient, customers[0].emailAddress, password);
  1816. await proceedToArrangingPayment(shopClient);
  1817. const order = await addPaymentToOrder(shopClient, twoStagePaymentMethod);
  1818. orderGuard.assertSuccess(order);
  1819. expect(order.state).toBe('PaymentAuthorized');
  1820. const paymentId = order.payments![0].id;
  1821. expect(onCancelPaymentSpy).not.toHaveBeenCalled();
  1822. const { cancelPayment } = await adminClient.query<
  1823. Codegen.CancelPaymentMutation,
  1824. Codegen.CancelPaymentMutationVariables
  1825. >(CANCEL_PAYMENT, {
  1826. paymentId,
  1827. });
  1828. paymentGuard.assertSuccess(cancelPayment);
  1829. expect(cancelPayment.state).toBe('Cancelled');
  1830. expect(cancelPayment.metadata.cancellationCode).toBe('12345');
  1831. expect(onCancelPaymentSpy).toHaveBeenCalledTimes(1);
  1832. });
  1833. it('cancellation failure', async () => {
  1834. await createTestOrder(adminClient, shopClient, customers[0].emailAddress, password);
  1835. await proceedToArrangingPayment(shopClient);
  1836. const order = await addPaymentToOrder(shopClient, failsToCancelPaymentMethod);
  1837. orderGuard.assertSuccess(order);
  1838. expect(order.state).toBe('PaymentAuthorized');
  1839. const paymentId = order.payments![0].id;
  1840. const { cancelPayment } = await adminClient.query<
  1841. Codegen.CancelPaymentMutation,
  1842. Codegen.CancelPaymentMutationVariables
  1843. >(CANCEL_PAYMENT, {
  1844. paymentId,
  1845. });
  1846. paymentGuard.assertErrorResult(cancelPayment);
  1847. expect(cancelPayment.message).toBe('Cancelling the payment failed');
  1848. const { order: checkorder } = await adminClient.query<
  1849. Codegen.GetOrderQuery,
  1850. Codegen.GetOrderQueryVariables
  1851. >(GET_ORDER, {
  1852. id: order.id,
  1853. });
  1854. expect(checkorder!.payments![0].state).toBe('Authorized');
  1855. expect(checkorder!.payments![0].metadata).toEqual({ cancellationData: 'foo' });
  1856. });
  1857. });
  1858. describe('refund by amount', () => {
  1859. let orderId: string;
  1860. let paymentId: string;
  1861. let refundId: string;
  1862. beforeAll(async () => {
  1863. const result = await createTestOrder(
  1864. adminClient,
  1865. shopClient,
  1866. customers[0].emailAddress,
  1867. password,
  1868. );
  1869. orderId = result.orderId;
  1870. await proceedToArrangingPayment(shopClient);
  1871. const order = await addPaymentToOrder(shopClient, singleStageRefundablePaymentMethod);
  1872. orderGuard.assertSuccess(order);
  1873. paymentId = order.payments![0].id;
  1874. });
  1875. it('return RefundAmountError if amount too large', async () => {
  1876. const { refundOrder } = await adminClient.query(RefundOrderDocument, {
  1877. input: {
  1878. lines: [],
  1879. shipping: 0,
  1880. adjustment: 0,
  1881. amount: 999999,
  1882. paymentId,
  1883. },
  1884. });
  1885. refundGuard.assertErrorResult(refundOrder);
  1886. expect(refundOrder.message).toBe(
  1887. 'The amount specified exceeds the refundable amount for this payment',
  1888. );
  1889. expect(refundOrder.errorCode).toBe(ErrorCode.REFUND_AMOUNT_ERROR);
  1890. });
  1891. it('creates a partial refund for the given amount', async () => {
  1892. const { order } = await adminClient.query(GetOrderDocument, {
  1893. id: orderId,
  1894. });
  1895. const refundAmount = order!.totalWithTax - 500;
  1896. const { refundOrder } = await adminClient.query(RefundOrderDocument, {
  1897. input: {
  1898. lines: [],
  1899. shipping: 0,
  1900. adjustment: 0,
  1901. amount: refundAmount,
  1902. paymentId,
  1903. },
  1904. });
  1905. refundGuard.assertSuccess(refundOrder);
  1906. expect(refundOrder.total).toBe(refundAmount);
  1907. });
  1908. });
  1909. describe('order notes', () => {
  1910. let orderId: string;
  1911. let firstNoteId: string;
  1912. beforeAll(async () => {
  1913. const result = await createTestOrder(
  1914. adminClient,
  1915. shopClient,
  1916. customers[2].emailAddress,
  1917. password,
  1918. );
  1919. orderId = result.orderId;
  1920. });
  1921. it('private note', async () => {
  1922. const { addNoteToOrder } = await adminClient.query<
  1923. Codegen.AddNoteToOrderMutation,
  1924. Codegen.AddNoteToOrderMutationVariables
  1925. >(ADD_NOTE_TO_ORDER, {
  1926. input: {
  1927. id: orderId,
  1928. note: 'A private note',
  1929. isPublic: false,
  1930. },
  1931. });
  1932. expect(addNoteToOrder.id).toBe(orderId);
  1933. const { order } = await adminClient.query<
  1934. Codegen.GetOrderHistoryQuery,
  1935. Codegen.GetOrderHistoryQueryVariables
  1936. >(GET_ORDER_HISTORY, {
  1937. id: orderId,
  1938. options: {
  1939. skip: 1,
  1940. },
  1941. });
  1942. expect(order!.history.items.map(pick(['type', 'data']))).toEqual([
  1943. {
  1944. type: HistoryEntryType.ORDER_NOTE,
  1945. data: {
  1946. note: 'A private note',
  1947. },
  1948. },
  1949. ]);
  1950. firstNoteId = order!.history.items[0].id;
  1951. const { activeOrder } = await shopClient.query<CodegenShop.GetActiveOrderQuery>(GET_ACTIVE_ORDER);
  1952. expect(activeOrder!.history.items.map(pick(['type']))).toEqual([
  1953. { type: HistoryEntryType.ORDER_STATE_TRANSITION },
  1954. ]);
  1955. });
  1956. it('public note', async () => {
  1957. const { addNoteToOrder } = await adminClient.query<
  1958. Codegen.AddNoteToOrderMutation,
  1959. Codegen.AddNoteToOrderMutationVariables
  1960. >(ADD_NOTE_TO_ORDER, {
  1961. input: {
  1962. id: orderId,
  1963. note: 'A public note',
  1964. isPublic: true,
  1965. },
  1966. });
  1967. expect(addNoteToOrder.id).toBe(orderId);
  1968. const { order } = await adminClient.query<
  1969. Codegen.GetOrderHistoryQuery,
  1970. Codegen.GetOrderHistoryQueryVariables
  1971. >(GET_ORDER_HISTORY, {
  1972. id: orderId,
  1973. options: {
  1974. skip: 2,
  1975. },
  1976. });
  1977. expect(order!.history.items.map(pick(['type', 'data']))).toEqual([
  1978. {
  1979. type: HistoryEntryType.ORDER_NOTE,
  1980. data: {
  1981. note: 'A public note',
  1982. },
  1983. },
  1984. ]);
  1985. const { activeOrder } = await shopClient.query<CodegenShop.GetActiveOrderQuery>(GET_ACTIVE_ORDER);
  1986. expect(activeOrder!.history.items.map(pick(['type', 'data']))).toEqual([
  1987. {
  1988. type: HistoryEntryType.ORDER_STATE_TRANSITION,
  1989. data: {
  1990. from: 'Created',
  1991. to: 'AddingItems',
  1992. },
  1993. },
  1994. {
  1995. type: HistoryEntryType.ORDER_NOTE,
  1996. data: {
  1997. note: 'A public note',
  1998. },
  1999. },
  2000. ]);
  2001. });
  2002. it('update note', async () => {
  2003. const { updateOrderNote } = await adminClient.query<
  2004. Codegen.UpdateOrderNoteMutation,
  2005. Codegen.UpdateOrderNoteMutationVariables
  2006. >(UPDATE_ORDER_NOTE, {
  2007. input: {
  2008. noteId: firstNoteId,
  2009. note: 'An updated note',
  2010. },
  2011. });
  2012. expect(updateOrderNote.data).toEqual({
  2013. note: 'An updated note',
  2014. });
  2015. });
  2016. it('delete note', async () => {
  2017. const { order: before } = await adminClient.query<
  2018. Codegen.GetOrderHistoryQuery,
  2019. Codegen.GetOrderHistoryQueryVariables
  2020. >(GET_ORDER_HISTORY, { id: orderId });
  2021. expect(before?.history.totalItems).toBe(3);
  2022. const { deleteOrderNote } = await adminClient.query<
  2023. Codegen.DeleteOrderNoteMutation,
  2024. Codegen.DeleteOrderNoteMutationVariables
  2025. >(DELETE_ORDER_NOTE, {
  2026. id: firstNoteId,
  2027. });
  2028. expect(deleteOrderNote.result).toBe(DeletionResult.DELETED);
  2029. const { order: after } = await adminClient.query<
  2030. Codegen.GetOrderHistoryQuery,
  2031. Codegen.GetOrderHistoryQueryVariables
  2032. >(GET_ORDER_HISTORY, { id: orderId });
  2033. expect(after?.history.totalItems).toBe(2);
  2034. });
  2035. });
  2036. describe('multiple payments', () => {
  2037. const PARTIAL_PAYMENT_AMOUNT = 1000;
  2038. let orderId: string;
  2039. let orderTotalWithTax: number;
  2040. let payment1Id: string;
  2041. let payment2Id: string;
  2042. let productInOrder: Codegen.GetProductWithVariantsQuery['product'];
  2043. beforeAll(async () => {
  2044. const result = await createTestOrder(
  2045. adminClient,
  2046. shopClient,
  2047. customers[1].emailAddress,
  2048. password,
  2049. );
  2050. orderId = result.orderId;
  2051. productInOrder = result.product;
  2052. });
  2053. it('adds a partial payment', async () => {
  2054. await proceedToArrangingPayment(shopClient, 2);
  2055. const { addPaymentToOrder: order } = await shopClient.query<
  2056. CodegenShop.AddPaymentToOrderMutation,
  2057. CodegenShop.AddPaymentToOrderMutationVariables
  2058. >(ADD_PAYMENT, {
  2059. input: {
  2060. method: partialPaymentMethod.code,
  2061. metadata: {
  2062. amount: PARTIAL_PAYMENT_AMOUNT,
  2063. },
  2064. },
  2065. });
  2066. orderGuard.assertSuccess(order);
  2067. orderTotalWithTax = order.totalWithTax;
  2068. expect(order.state).toBe('ArrangingPayment');
  2069. expect(order.payments?.length).toBe(1);
  2070. expect(omit(order.payments![0], ['id'])).toEqual({
  2071. amount: PARTIAL_PAYMENT_AMOUNT,
  2072. metadata: {
  2073. public: {
  2074. amount: PARTIAL_PAYMENT_AMOUNT,
  2075. },
  2076. },
  2077. method: partialPaymentMethod.code,
  2078. state: 'Settled',
  2079. transactionId: '12345',
  2080. });
  2081. payment1Id = order.payments![0].id;
  2082. });
  2083. it('adds another payment to make up order totalWithTax', async () => {
  2084. const { addPaymentToOrder: order } = await shopClient.query<
  2085. CodegenShop.AddPaymentToOrderMutation,
  2086. CodegenShop.AddPaymentToOrderMutationVariables
  2087. >(ADD_PAYMENT, {
  2088. input: {
  2089. method: singleStageRefundablePaymentMethod.code,
  2090. metadata: {},
  2091. },
  2092. });
  2093. orderGuard.assertSuccess(order);
  2094. expect(order.state).toBe('PaymentSettled');
  2095. expect(order.payments?.length).toBe(2);
  2096. expect(
  2097. omit(order.payments!.find(p => p.method === singleStageRefundablePaymentMethod.code)!, [
  2098. 'id',
  2099. ]),
  2100. ).toEqual({
  2101. amount: orderTotalWithTax - PARTIAL_PAYMENT_AMOUNT,
  2102. metadata: {},
  2103. method: singleStageRefundablePaymentMethod.code,
  2104. state: 'Settled',
  2105. transactionId: '12345',
  2106. });
  2107. payment2Id = order.payments![1].id;
  2108. });
  2109. it('partial refunding of order with multiple payments', async () => {
  2110. const { order } = await adminClient.query<Codegen.GetOrderQuery, Codegen.GetOrderQueryVariables>(
  2111. GET_ORDER,
  2112. {
  2113. id: orderId,
  2114. },
  2115. );
  2116. const { refundOrder } = await adminClient.query<
  2117. Codegen.RefundOrderMutation,
  2118. Codegen.RefundOrderMutationVariables
  2119. >(REFUND_ORDER, {
  2120. input: {
  2121. lines: order!.lines.map(l => ({ orderLineId: l.id, quantity: 1 })),
  2122. shipping: 0,
  2123. adjustment: 0,
  2124. reason: 'first refund',
  2125. paymentId: payment1Id,
  2126. },
  2127. });
  2128. refundGuard.assertSuccess(refundOrder);
  2129. expect(refundOrder.total).toBe(PARTIAL_PAYMENT_AMOUNT);
  2130. const { order: orderWithPayments } = await adminClient.query<
  2131. Codegen.GetOrderWithPaymentsQuery,
  2132. Codegen.GetOrderWithPaymentsQueryVariables
  2133. >(GET_ORDER_WITH_PAYMENTS, {
  2134. id: orderId,
  2135. });
  2136. expect(orderWithPayments?.payments!.sort(sortById)[0].refunds.length).toBe(1);
  2137. expect(orderWithPayments?.payments!.sort(sortById)[0].refunds[0].total).toBe(
  2138. PARTIAL_PAYMENT_AMOUNT,
  2139. );
  2140. expect(orderWithPayments?.payments!.sort(sortById)[1].refunds.length).toBe(1);
  2141. expect(orderWithPayments?.payments!.sort(sortById)[1].refunds[0].total).toBe(
  2142. productInOrder!.variants[0].priceWithTax - PARTIAL_PAYMENT_AMOUNT,
  2143. );
  2144. });
  2145. it('refunding remaining amount of order with multiple payments', async () => {
  2146. const { order } = await adminClient.query<Codegen.GetOrderQuery, Codegen.GetOrderQueryVariables>(
  2147. GET_ORDER,
  2148. {
  2149. id: orderId,
  2150. },
  2151. );
  2152. const { refundOrder } = await adminClient.query<
  2153. Codegen.RefundOrderMutation,
  2154. Codegen.RefundOrderMutationVariables
  2155. >(REFUND_ORDER, {
  2156. input: {
  2157. lines: order!.lines.map(l => ({ orderLineId: l.id, quantity: 1 })),
  2158. shipping: order!.shippingWithTax,
  2159. adjustment: 0,
  2160. reason: 'second refund',
  2161. paymentId: payment1Id,
  2162. },
  2163. });
  2164. refundGuard.assertSuccess(refundOrder);
  2165. expect(refundOrder.total).toBe(order!.totalWithTax - order!.lines[0].unitPriceWithTax);
  2166. const { order: orderWithPayments } = await adminClient.query<
  2167. Codegen.GetOrderWithPaymentsQuery,
  2168. Codegen.GetOrderWithPaymentsQueryVariables
  2169. >(GET_ORDER_WITH_PAYMENTS, {
  2170. id: orderId,
  2171. });
  2172. expect(orderWithPayments?.payments!.sort(sortById)[0].refunds.length).toBe(1);
  2173. expect(orderWithPayments?.payments!.sort(sortById)[0].refunds[0].total).toBe(
  2174. PARTIAL_PAYMENT_AMOUNT,
  2175. );
  2176. expect(orderWithPayments?.payments!.sort(sortById)[1].refunds.length).toBe(2);
  2177. expect(orderWithPayments?.payments!.sort(sortById)[1].refunds[0].total).toBe(
  2178. productInOrder!.variants[0].priceWithTax - PARTIAL_PAYMENT_AMOUNT,
  2179. );
  2180. expect(orderWithPayments?.payments!.sort(sortById)[1].refunds[1].total).toBe(
  2181. productInOrder!.variants[0].priceWithTax + order!.shippingWithTax,
  2182. );
  2183. });
  2184. // https://github.com/vendurehq/vendure/issues/847
  2185. it('manual call to settlePayment works with multiple payments', async () => {
  2186. const result = await createTestOrder(
  2187. adminClient,
  2188. shopClient,
  2189. customers[1].emailAddress,
  2190. password,
  2191. );
  2192. await proceedToArrangingPayment(shopClient);
  2193. await shopClient.query<
  2194. CodegenShop.AddPaymentToOrderMutation,
  2195. CodegenShop.AddPaymentToOrderMutationVariables
  2196. >(ADD_PAYMENT, {
  2197. input: {
  2198. method: partialPaymentMethod.code,
  2199. metadata: {
  2200. amount: PARTIAL_PAYMENT_AMOUNT,
  2201. authorizeOnly: true,
  2202. },
  2203. },
  2204. });
  2205. const { addPaymentToOrder: order } = await shopClient.query<
  2206. CodegenShop.AddPaymentToOrderMutation,
  2207. CodegenShop.AddPaymentToOrderMutationVariables
  2208. >(ADD_PAYMENT, {
  2209. input: {
  2210. method: singleStageRefundablePaymentMethod.code,
  2211. metadata: {},
  2212. },
  2213. });
  2214. orderGuard.assertSuccess(order);
  2215. expect(order.state).toBe('PaymentAuthorized');
  2216. const { settlePayment } = await adminClient.query<
  2217. Codegen.SettlePaymentMutation,
  2218. Codegen.SettlePaymentMutationVariables
  2219. >(SETTLE_PAYMENT, {
  2220. id: order.payments!.find(p => p.method === partialPaymentMethod.code)!.id,
  2221. });
  2222. paymentGuard.assertSuccess(settlePayment);
  2223. expect(settlePayment.state).toBe('Settled');
  2224. const { order: order2 } = await adminClient.query<
  2225. Codegen.GetOrderQuery,
  2226. Codegen.GetOrderQueryVariables
  2227. >(GET_ORDER, {
  2228. id: order.id,
  2229. });
  2230. expect(order2?.state).toBe('PaymentSettled');
  2231. });
  2232. });
  2233. // https://github.com/vendurehq/vendure/issues/2505
  2234. describe('updating order customer', () => {
  2235. let orderId: string;
  2236. let customerId: string;
  2237. it('set up order', async () => {
  2238. const result = await createTestOrder(
  2239. adminClient,
  2240. shopClient,
  2241. customers[1].emailAddress,
  2242. password,
  2243. );
  2244. orderId = result.orderId;
  2245. customerId = customers[1].id;
  2246. await proceedToArrangingPayment(shopClient);
  2247. const order = await addPaymentToOrder(shopClient, singleStageRefundablePaymentMethod);
  2248. orderGuard.assertSuccess(order);
  2249. expect(order.customer?.id).toBe(customerId);
  2250. });
  2251. it(
  2252. 'throws in invalid orderId',
  2253. assertThrowsWithMessage(async () => {
  2254. await adminClient.query<
  2255. Codegen.SetOrderCustomerMutation,
  2256. Codegen.SetOrderCustomerMutationVariables
  2257. >(SET_ORDER_CUSTOMER, {
  2258. input: {
  2259. orderId: 'T_9999',
  2260. customerId: customers[2].id,
  2261. note: 'Testing',
  2262. },
  2263. });
  2264. }, 'No Order with the id "9999" could be found'),
  2265. );
  2266. it(
  2267. 'throws in invalid orderId',
  2268. assertThrowsWithMessage(async () => {
  2269. await adminClient.query<
  2270. Codegen.SetOrderCustomerMutation,
  2271. Codegen.SetOrderCustomerMutationVariables
  2272. >(SET_ORDER_CUSTOMER, {
  2273. input: {
  2274. orderId,
  2275. customerId: 'T_999',
  2276. note: 'Testing',
  2277. },
  2278. });
  2279. }, 'No Customer with the id "999" could be found'),
  2280. );
  2281. it('update order customer', async () => {
  2282. const newCustomerId = customers[2].id;
  2283. const { setOrderCustomer } = await adminClient.query<
  2284. Codegen.SetOrderCustomerMutation,
  2285. Codegen.SetOrderCustomerMutationVariables
  2286. >(SET_ORDER_CUSTOMER, {
  2287. input: {
  2288. orderId,
  2289. customerId: customers[2].id,
  2290. note: 'Testing',
  2291. },
  2292. });
  2293. expect(setOrderCustomer?.customer?.id).toBe(newCustomerId);
  2294. });
  2295. it('adds a history entry for the customer update', async () => {
  2296. const { order } = await adminClient.query<
  2297. Codegen.GetOrderHistoryQuery,
  2298. Codegen.GetOrderHistoryQueryVariables
  2299. >(GET_ORDER_HISTORY, {
  2300. id: orderId,
  2301. options: {
  2302. skip: 4,
  2303. },
  2304. });
  2305. expect(order!.history.items.map(pick(['type', 'data']))).toEqual([
  2306. {
  2307. data: {
  2308. previousCustomerId: customerId,
  2309. previousCustomerName: 'Trevor Donnelly',
  2310. newCustomerId: customers[2].id,
  2311. newCustomerName: `${customers[2].firstName} ${customers[2].lastName}`,
  2312. note: 'Testing',
  2313. },
  2314. type: HistoryEntryType.ORDER_CUSTOMER_UPDATED,
  2315. },
  2316. ]);
  2317. });
  2318. });
  2319. describe('issues', () => {
  2320. // https://github.com/vendurehq/vendure/issues/639
  2321. it('returns fulfillments for Order with no lines', async () => {
  2322. await shopClient.asAnonymousUser();
  2323. // Apply a coupon code just to create an active order with no OrderLines
  2324. await shopClient.query<
  2325. CodegenShop.ApplyCouponCodeMutation,
  2326. CodegenShop.ApplyCouponCodeMutationVariables
  2327. >(APPLY_COUPON_CODE, {
  2328. couponCode: 'TEST',
  2329. });
  2330. const { activeOrder } = await shopClient.query<CodegenShop.GetActiveOrderQuery>(GET_ACTIVE_ORDER);
  2331. const { order } = await adminClient.query<
  2332. Codegen.GetOrderFulfillmentsQuery,
  2333. Codegen.GetOrderFulfillmentsQueryVariables
  2334. >(GET_ORDER_FULFILLMENTS, {
  2335. id: activeOrder!.id,
  2336. });
  2337. expect(order?.fulfillments).toEqual([]);
  2338. });
  2339. // https://github.com/vendurehq/vendure/issues/603
  2340. it('orders correctly resolves quantities and OrderItems', async () => {
  2341. await shopClient.asAnonymousUser();
  2342. const { addItemToOrder } = await shopClient.query<
  2343. CodegenShop.AddItemToOrderMutation,
  2344. CodegenShop.AddItemToOrderMutationVariables
  2345. >(ADD_ITEM_TO_ORDER, {
  2346. productVariantId: 'T_1',
  2347. quantity: 2,
  2348. });
  2349. orderGuard.assertSuccess(addItemToOrder);
  2350. const { orders } = await adminClient.query<
  2351. Codegen.GetOrderListWithQtyQuery,
  2352. Codegen.GetOrderListWithQtyQueryVariables
  2353. >(GET_ORDERS_LIST_WITH_QUANTITIES, {
  2354. options: {
  2355. filter: {
  2356. code: { eq: addItemToOrder.code },
  2357. },
  2358. },
  2359. });
  2360. expect(orders.items[0].totalQuantity).toBe(2);
  2361. expect(orders.items[0].lines[0].quantity).toBe(2);
  2362. });
  2363. // https://github.com/vendurehq/vendure/issues/716
  2364. it('get an Order with a deleted ShippingMethod', async () => {
  2365. const { createShippingMethod: shippingMethod } = await adminClient.query<
  2366. Codegen.CreateShippingMethodMutation,
  2367. Codegen.CreateShippingMethodMutationVariables
  2368. >(CREATE_SHIPPING_METHOD, {
  2369. input: {
  2370. code: 'royal-mail',
  2371. translations: [{ languageCode: LanguageCode.en, name: 'Royal Mail', description: '' }],
  2372. fulfillmentHandler: manualFulfillmentHandler.code,
  2373. checker: {
  2374. code: defaultShippingEligibilityChecker.code,
  2375. arguments: [{ name: 'orderMinimum', value: '0' }],
  2376. },
  2377. calculator: {
  2378. code: defaultShippingCalculator.code,
  2379. arguments: [
  2380. { name: 'rate', value: '500' },
  2381. { name: 'taxRate', value: '0' },
  2382. ],
  2383. },
  2384. },
  2385. });
  2386. await shopClient.asUserWithCredentials(customers[0].emailAddress, password);
  2387. await shopClient.query<
  2388. CodegenShop.AddItemToOrderMutation,
  2389. CodegenShop.AddItemToOrderMutationVariables
  2390. >(ADD_ITEM_TO_ORDER, {
  2391. productVariantId: 'T_1',
  2392. quantity: 2,
  2393. });
  2394. await shopClient.query<
  2395. CodegenShop.SetShippingAddressMutation,
  2396. CodegenShop.SetShippingAddressMutationVariables
  2397. >(SET_SHIPPING_ADDRESS, {
  2398. input: {
  2399. fullName: 'name',
  2400. streetLine1: '12 the street',
  2401. city: 'foo',
  2402. postalCode: '123456',
  2403. countryCode: 'US',
  2404. },
  2405. });
  2406. const { setOrderShippingMethod: order } = await shopClient.query<
  2407. CodegenShop.SetShippingMethodMutation,
  2408. CodegenShop.SetShippingMethodMutationVariables
  2409. >(SET_SHIPPING_METHOD, {
  2410. id: shippingMethod.id,
  2411. });
  2412. orderGuard.assertSuccess(order);
  2413. await adminClient.query<
  2414. Codegen.DeleteShippingMethodMutation,
  2415. Codegen.DeleteShippingMethodMutationVariables
  2416. >(DELETE_SHIPPING_METHOD, {
  2417. id: shippingMethod.id,
  2418. });
  2419. const { order: order2 } = await adminClient.query<
  2420. Codegen.GetOrderQuery,
  2421. Codegen.GetOrderQueryVariables
  2422. >(GET_ORDER, {
  2423. id: order.id,
  2424. });
  2425. expect(order2?.shippingLines[0]).toEqual({
  2426. priceWithTax: 500,
  2427. shippingMethod: pick(shippingMethod, ['id', 'name', 'code', 'description']),
  2428. });
  2429. });
  2430. // https://github.com/vendurehq/vendure/issues/868
  2431. it('allows multiple refunds of same OrderLine', async () => {
  2432. await shopClient.asUserWithCredentials(customers[0].emailAddress, password);
  2433. const { addItemToOrder } = await shopClient.query<
  2434. CodegenShop.AddItemToOrderMutation,
  2435. CodegenShop.AddItemToOrderMutationVariables
  2436. >(ADD_ITEM_TO_ORDER, {
  2437. productVariantId: 'T_1',
  2438. quantity: 2,
  2439. });
  2440. await proceedToArrangingPayment(shopClient);
  2441. const order = await addPaymentToOrder(shopClient, singleStageRefundablePaymentMethod);
  2442. orderGuard.assertSuccess(order);
  2443. const { refundOrder: refund1 } = await adminClient.query<
  2444. Codegen.RefundOrderMutation,
  2445. Codegen.RefundOrderMutationVariables
  2446. >(REFUND_ORDER, {
  2447. input: {
  2448. lines: order.lines.map(l => ({ orderLineId: l.id, quantity: 1 })),
  2449. shipping: 0,
  2450. adjustment: 0,
  2451. reason: 'foo',
  2452. paymentId: order.payments![0].id,
  2453. },
  2454. });
  2455. refundGuard.assertSuccess(refund1);
  2456. const { refundOrder: refund2 } = await adminClient.query<
  2457. Codegen.RefundOrderMutation,
  2458. Codegen.RefundOrderMutationVariables
  2459. >(REFUND_ORDER, {
  2460. input: {
  2461. lines: order.lines.map(l => ({ orderLineId: l.id, quantity: 1 })),
  2462. shipping: 0,
  2463. adjustment: 0,
  2464. reason: 'foo',
  2465. paymentId: order.payments![0].id,
  2466. },
  2467. });
  2468. refundGuard.assertSuccess(refund2);
  2469. });
  2470. // https://github.com/vendurehq/vendure/issues/1125
  2471. it('resolves deleted Product of OrderLine ProductVariants', async () => {
  2472. await shopClient.asUserWithCredentials(customers[0].emailAddress, password);
  2473. const { addItemToOrder } = await shopClient.query<
  2474. CodegenShop.AddItemToOrderMutation,
  2475. CodegenShop.AddItemToOrderMutationVariables
  2476. >(ADD_ITEM_TO_ORDER, {
  2477. productVariantId: 'T_7',
  2478. quantity: 1,
  2479. });
  2480. await proceedToArrangingPayment(shopClient);
  2481. const order = await addPaymentToOrder(shopClient, singleStageRefundablePaymentMethod);
  2482. orderGuard.assertSuccess(order);
  2483. await adminClient.query<Codegen.DeleteProductMutation, Codegen.DeleteProductMutationVariables>(
  2484. DELETE_PRODUCT,
  2485. {
  2486. id: 'T_3',
  2487. },
  2488. );
  2489. const { activeCustomer } = await shopClient.query<
  2490. CodegenShop.GetActiveCustomerWithOrdersProductSlugQuery,
  2491. CodegenShop.GetActiveCustomerWithOrdersProductSlugQueryVariables
  2492. >(GET_ACTIVE_CUSTOMER_WITH_ORDERS_PRODUCT_SLUG, {
  2493. options: {
  2494. sort: {
  2495. createdAt: SortOrder.ASC,
  2496. },
  2497. },
  2498. });
  2499. expect(
  2500. activeCustomer!.orders.items[activeCustomer!.orders.items.length - 1].lines[0].productVariant
  2501. .product.slug,
  2502. ).toBe('gaming-pc');
  2503. });
  2504. // https://github.com/vendurehq/vendure/issues/1508
  2505. it('resolves price of deleted ProductVariant of OrderLine', async () => {
  2506. const { activeCustomer } = await shopClient.query<
  2507. CodegenShop.GetActiveCustomerWithOrdersProductPriceQuery,
  2508. CodegenShop.GetActiveCustomerWithOrdersProductPriceQueryVariables
  2509. >(GET_ACTIVE_CUSTOMER_WITH_ORDERS_PRODUCT_PRICE, {
  2510. options: {
  2511. sort: {
  2512. createdAt: SortOrder.ASC,
  2513. },
  2514. },
  2515. });
  2516. expect(
  2517. activeCustomer!.orders.items[activeCustomer!.orders.items.length - 1].lines[0].productVariant
  2518. .price,
  2519. ).toBe(108720);
  2520. });
  2521. // https://github.com/vendurehq/vendure/issues/2204
  2522. it('creates correct history entries and results in correct state when manually adding payment to order', async () => {
  2523. await shopClient.asUserWithCredentials(customers[0].emailAddress, password);
  2524. const { addItemToOrder } = await shopClient.query<
  2525. CodegenShop.AddItemToOrderMutation,
  2526. CodegenShop.AddItemToOrderMutationVariables
  2527. >(ADD_ITEM_TO_ORDER, {
  2528. productVariantId: 'T_1',
  2529. quantity: 2,
  2530. });
  2531. await proceedToArrangingPayment(shopClient);
  2532. orderGuard.assertSuccess(addItemToOrder);
  2533. const { addManualPaymentToOrder } = await adminClient.query(AddManualPaymentDocument, {
  2534. input: {
  2535. orderId: addItemToOrder.id,
  2536. metadata: {},
  2537. method: twoStagePaymentMethod.code,
  2538. transactionId: '12345',
  2539. },
  2540. });
  2541. orderGuard.assertSuccess(addManualPaymentToOrder);
  2542. const { order: orderWithHistory } = await adminClient.query(GetOrderHistoryDocument, {
  2543. id: addManualPaymentToOrder.id,
  2544. });
  2545. const stateTransitionHistory = orderWithHistory!.history.items
  2546. .filter(i => i.type === HistoryEntryType.ORDER_STATE_TRANSITION)
  2547. .map(i => i.data);
  2548. expect(stateTransitionHistory).toEqual([
  2549. { from: 'Created', to: 'AddingItems' },
  2550. { from: 'AddingItems', to: 'ArrangingPayment' },
  2551. { from: 'ArrangingPayment', to: 'PaymentSettled' },
  2552. ]);
  2553. const { order } = await adminClient.query(GetOrderDocument, {
  2554. id: addManualPaymentToOrder.id,
  2555. });
  2556. expect(order!.state).toBe('PaymentSettled');
  2557. });
  2558. // https://github.com/vendurehq/vendure/issues/2191
  2559. it('correctly transitions order & fulfillment on partial fulfillment being shipped', async () => {
  2560. await shopClient.asUserWithCredentials(customers[0].emailAddress, password);
  2561. const { addItemToOrder } = await shopClient.query<
  2562. CodegenShop.AddItemToOrderMutation,
  2563. CodegenShop.AddItemToOrderMutationVariables
  2564. >(ADD_ITEM_TO_ORDER, {
  2565. productVariantId: 'T_6',
  2566. quantity: 3,
  2567. });
  2568. await proceedToArrangingPayment(shopClient);
  2569. orderGuard.assertSuccess(addItemToOrder);
  2570. const order = await addPaymentToOrder(shopClient, singleStageRefundablePaymentMethod);
  2571. orderGuard.assertSuccess(order);
  2572. const { addFulfillmentToOrder } = await adminClient.query(CreateFulfillmentDocument, {
  2573. input: {
  2574. lines: [{ orderLineId: order.lines[0].id, quantity: 2 }],
  2575. handler: {
  2576. code: manualFulfillmentHandler.code,
  2577. arguments: [
  2578. { name: 'method', value: 'Test2' },
  2579. { name: 'trackingCode', value: '222' },
  2580. ],
  2581. },
  2582. },
  2583. });
  2584. fulfillmentGuard.assertSuccess(addFulfillmentToOrder);
  2585. const { transitionFulfillmentToState } = await adminClient.query(TransitFulfillmentDocument, {
  2586. id: addFulfillmentToOrder.id,
  2587. state: 'Shipped',
  2588. });
  2589. fulfillmentGuard.assertSuccess(transitionFulfillmentToState);
  2590. expect(transitionFulfillmentToState.id).toBe(addFulfillmentToOrder.id);
  2591. expect(transitionFulfillmentToState.state).toBe('Shipped');
  2592. const { order: order2 } = await adminClient.query(GetOrderDocument, {
  2593. id: order.id,
  2594. });
  2595. expect(order2?.state).toBe('PartiallyShipped');
  2596. });
  2597. });
  2598. describe('multiple items to order', () => {
  2599. it('adds multiple items to a new active order', async () => {
  2600. await shopClient.asAnonymousUser();
  2601. const { addItemsToOrder } = await shopClient.query<
  2602. CodegenShop.AddItemsToOrderMutation,
  2603. CodegenShop.AddItemsToOrderMutationVariables
  2604. >(ADD_MULTIPLE_ITEMS_TO_ORDER, {
  2605. inputs: [
  2606. {
  2607. productVariantId: 'T_1',
  2608. quantity: 5,
  2609. },
  2610. {
  2611. productVariantId: 'T_2',
  2612. quantity: 3,
  2613. },
  2614. ],
  2615. });
  2616. expect(addItemsToOrder.order.lines.length).toBe(2);
  2617. expect(addItemsToOrder.order.lines[0].quantity).toBe(5);
  2618. expect(addItemsToOrder.order.lines[1].quantity).toBe(3);
  2619. });
  2620. it('adds successful items and returns error results for failed items', async () => {
  2621. await shopClient.asAnonymousUser();
  2622. const { addItemsToOrder } = await shopClient.query<
  2623. CodegenShop.AddItemsToOrderMutation,
  2624. CodegenShop.AddItemsToOrderMutationVariables
  2625. >(ADD_MULTIPLE_ITEMS_TO_ORDER, {
  2626. inputs: [
  2627. {
  2628. productVariantId: 'T_1',
  2629. quantity: 1,
  2630. },
  2631. {
  2632. productVariantId: 'T_2',
  2633. quantity: 999999, // Exceeds limit
  2634. },
  2635. ],
  2636. });
  2637. const t1 = addItemsToOrder.order.lines.find(l => l.productVariant.id === 'T_1');
  2638. // Should have added 1 of T_1
  2639. expect(t1?.quantity).toBe(1);
  2640. // Should not have added T_2
  2641. const t2 = addItemsToOrder.order.lines.find(l => l.productVariant.id === 'T_2');
  2642. expect(t2).toBeUndefined();
  2643. // Should have errors
  2644. expect(addItemsToOrder.errorResults.length).toBe(1);
  2645. expect(addItemsToOrder.errorResults[0].errorCode).toBe('ORDER_LIMIT_ERROR');
  2646. expect(addItemsToOrder.errorResults[0].message).toBe('ORDER_LIMIT_ERROR');
  2647. });
  2648. });
  2649. });
  2650. async function createTestOrder(
  2651. adminClient: SimpleGraphQLClient,
  2652. shopClient: SimpleGraphQLClient,
  2653. emailAddress: string,
  2654. password: string,
  2655. ): Promise<{
  2656. orderId: string;
  2657. product: Codegen.GetProductWithVariantsQuery['product'];
  2658. productVariantId: string;
  2659. }> {
  2660. const result = await adminClient.query<
  2661. Codegen.GetProductWithVariantsQuery,
  2662. Codegen.GetProductWithVariantsQueryVariables
  2663. >(GET_PRODUCT_WITH_VARIANTS, {
  2664. id: 'T_3',
  2665. });
  2666. const product = result.product!;
  2667. const productVariantId = product.variants[0].id;
  2668. // Set the ProductVariant to trackInventory
  2669. const { updateProductVariants } = await adminClient.query<
  2670. Codegen.UpdateProductVariantsMutation,
  2671. Codegen.UpdateProductVariantsMutationVariables
  2672. >(UPDATE_PRODUCT_VARIANTS, {
  2673. input: [
  2674. {
  2675. id: productVariantId,
  2676. trackInventory: GlobalFlag.TRUE,
  2677. },
  2678. ],
  2679. });
  2680. // Add the ProductVariant to the Order
  2681. await shopClient.asUserWithCredentials(emailAddress, password);
  2682. const { addItemToOrder } = await shopClient.query<
  2683. CodegenShop.AddItemToOrderMutation,
  2684. CodegenShop.AddItemToOrderMutationVariables
  2685. >(ADD_ITEM_TO_ORDER, {
  2686. productVariantId,
  2687. quantity: 2,
  2688. });
  2689. const orderId = (addItemToOrder as CodegenShop.UpdatedOrderFragment).id;
  2690. return { product, productVariantId, orderId };
  2691. }
  2692. async function getUnfulfilledOrderLineInput(
  2693. client: SimpleGraphQLClient,
  2694. id: string,
  2695. ): Promise<OrderLineInput[]> {
  2696. const { order } = await client.query<Codegen.GetOrderQuery, Codegen.GetOrderQueryVariables>(GET_ORDER, {
  2697. id,
  2698. });
  2699. const allFulfillmentLines =
  2700. order?.fulfillments
  2701. ?.filter(f => f.state !== 'Cancelled')
  2702. .reduce((all, f) => [...all, ...f.lines], [] as Codegen.FulfillmentFragment['lines']) || [];
  2703. const unfulfilledItems =
  2704. order?.lines
  2705. .map(l => {
  2706. const fulfilledQuantity = allFulfillmentLines
  2707. .filter(fl => fl.orderLineId === l.id)
  2708. .reduce((sum, fl) => sum + fl.quantity, 0);
  2709. return { orderLineId: l.id, unfulfilled: l.quantity - fulfilledQuantity };
  2710. })
  2711. .filter(l => 0 < l.unfulfilled) || [];
  2712. return unfulfilledItems.map(l => ({
  2713. orderLineId: l.orderLineId,
  2714. quantity: l.unfulfilled,
  2715. }));
  2716. }
  2717. export const GET_ORDER_LIST_FULFILLMENTS = gql`
  2718. query GetOrderListFulfillments {
  2719. orders {
  2720. items {
  2721. id
  2722. state
  2723. fulfillments {
  2724. id
  2725. state
  2726. nextStates
  2727. method
  2728. }
  2729. }
  2730. }
  2731. }
  2732. `;
  2733. export const GET_ORDER_FULFILLMENT_ITEMS = gql`
  2734. query GetOrderFulfillmentItems($id: ID!) {
  2735. order(id: $id) {
  2736. id
  2737. state
  2738. fulfillments {
  2739. ...Fulfillment
  2740. }
  2741. }
  2742. }
  2743. ${FULFILLMENT_FRAGMENT}
  2744. `;
  2745. const REFUND_FRAGMENT = gql`
  2746. fragment Refund on Refund {
  2747. id
  2748. state
  2749. items
  2750. transactionId
  2751. shipping
  2752. total
  2753. metadata
  2754. }
  2755. `;
  2756. export const REFUND_ORDER = gql`
  2757. mutation RefundOrder($input: RefundOrderInput!) {
  2758. refundOrder(input: $input) {
  2759. ...Refund
  2760. ... on ErrorResult {
  2761. errorCode
  2762. message
  2763. }
  2764. }
  2765. }
  2766. ${REFUND_FRAGMENT}
  2767. `;
  2768. export const SETTLE_REFUND = gql`
  2769. mutation SettleRefund($input: SettleRefundInput!) {
  2770. settleRefund(input: $input) {
  2771. ...Refund
  2772. ... on ErrorResult {
  2773. errorCode
  2774. message
  2775. }
  2776. }
  2777. }
  2778. ${REFUND_FRAGMENT}
  2779. `;
  2780. export const ADD_NOTE_TO_ORDER = gql`
  2781. mutation AddNoteToOrder($input: AddNoteToOrderInput!) {
  2782. addNoteToOrder(input: $input) {
  2783. id
  2784. }
  2785. }
  2786. `;
  2787. export const UPDATE_ORDER_NOTE = gql`
  2788. mutation UpdateOrderNote($input: UpdateOrderNoteInput!) {
  2789. updateOrderNote(input: $input) {
  2790. id
  2791. data
  2792. isPublic
  2793. }
  2794. }
  2795. `;
  2796. export const DELETE_ORDER_NOTE = gql`
  2797. mutation DeleteOrderNote($id: ID!) {
  2798. deleteOrderNote(id: $id) {
  2799. result
  2800. message
  2801. }
  2802. }
  2803. `;
  2804. const GET_ORDER_WITH_PAYMENTS = gql`
  2805. query GetOrderWithPayments($id: ID!) {
  2806. order(id: $id) {
  2807. id
  2808. payments {
  2809. id
  2810. errorMessage
  2811. metadata
  2812. refunds {
  2813. id
  2814. total
  2815. }
  2816. }
  2817. }
  2818. }
  2819. `;
  2820. export const GET_ORDER_LINE_FULFILLMENTS = gql`
  2821. query GetOrderLineFulfillments($id: ID!) {
  2822. order(id: $id) {
  2823. id
  2824. lines {
  2825. id
  2826. fulfillmentLines {
  2827. fulfillment {
  2828. id
  2829. state
  2830. }
  2831. orderLineId
  2832. quantity
  2833. }
  2834. }
  2835. }
  2836. }
  2837. `;
  2838. const GET_ORDERS_LIST_WITH_QUANTITIES = gql`
  2839. query GetOrderListWithQty($options: OrderListOptions) {
  2840. orders(options: $options) {
  2841. items {
  2842. id
  2843. code
  2844. totalQuantity
  2845. lines {
  2846. id
  2847. quantity
  2848. }
  2849. }
  2850. }
  2851. }
  2852. `;
  2853. const CANCEL_PAYMENT = gql`
  2854. mutation CancelPayment($paymentId: ID!) {
  2855. cancelPayment(id: $paymentId) {
  2856. ...Payment
  2857. ... on ErrorResult {
  2858. errorCode
  2859. message
  2860. }
  2861. ... on PaymentStateTransitionError {
  2862. transitionError
  2863. }
  2864. ... on CancelPaymentError {
  2865. paymentErrorMessage
  2866. }
  2867. }
  2868. }
  2869. ${PAYMENT_FRAGMENT}
  2870. `;
  2871. const SET_ORDER_CUSTOMER = gql`
  2872. mutation SetOrderCustomer($input: SetOrderCustomerInput!) {
  2873. setOrderCustomer(input: $input) {
  2874. id
  2875. customer {
  2876. id
  2877. }
  2878. }
  2879. }
  2880. `;