enum.graphql 100 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597
  1. # The set of valid sort keys for the Event query.
  2. enum EventSortKeys {
  3. # Sort by `the created_at` value.
  4. CREATED_AT
  5. # Sort by the `id` value.
  6. ID
  7. # Sort by relevance to the search terms when the query parameter is specified on the connection.
  8. # Don't use this sort key when no search query is specified.
  9. RELEVANCE
  10. }
  11. # Possible metafield validation statuses.
  12. enum MetafieldValidationStatus {
  13. # Any validation status (valid or invalid).
  14. ANY
  15. # Valid (according to definition).
  16. VALID
  17. # Invalid (according to definition).
  18. INVALID
  19. }
  20. # Possible types of a metafield's owner resource.
  21. enum MetafieldOwnerType {
  22. # The Api Permission metafield owner type.
  23. API_PERMISSION
  24. # The Article metafield owner type.
  25. ARTICLE
  26. # The Blog metafield owner type.
  27. BLOG
  28. # The Collection metafield owner type.
  29. COLLECTION
  30. # The Customer metafield owner type.
  31. CUSTOMER
  32. # The Discount metafield owner type.
  33. DISCOUNT
  34. # The Draft Order metafield owner type.
  35. DRAFTORDER
  36. # The Location metafield owner type.
  37. LOCATION
  38. # The Order metafield owner type.
  39. ORDER
  40. # The Page metafield owner type.
  41. PAGE
  42. # The Product metafield owner type.
  43. PRODUCT
  44. # The Product Image metafield owner type.
  45. PRODUCTIMAGE
  46. # The Product Variant metafield owner type.
  47. PRODUCTVARIANT
  48. # The Shop metafield owner type.
  49. SHOP
  50. }
  51. # Possible metafield definition validation statuses.
  52. enum MetafieldDefinitionValidationStatus {
  53. # All of this definition's metafields are valid.
  54. ALL_VALID
  55. # Asynchronous validation of this definition's metafields is in progress.
  56. IN_PROGRESS
  57. # Some of this definition's metafields are invalid.
  58. SOME_INVALID
  59. }
  60. # Supported private metafield value types.
  61. enum PrivateMetafieldValueType {
  62. # A string metafield.
  63. STRING
  64. # An integer metafield.
  65. INTEGER
  66. # A JSON string metafield.
  67. JSON_STRING
  68. }
  69. # The part of the image that should remain after cropping.
  70. enum CropRegion {
  71. # Keep the center of the image.
  72. CENTER
  73. # Keep the top of the image.
  74. TOP
  75. # Keep the bottom of the image.
  76. BOTTOM
  77. # Keep the left of the image.
  78. LEFT
  79. # Keep the right of the image.
  80. RIGHT
  81. }
  82. # List of supported image content types.
  83. enum ImageContentType {
  84. # A PNG image.
  85. PNG
  86. # A JPG image.
  87. JPG
  88. # A WEBP image.
  89. WEBP
  90. }
  91. # The purpose of a localization extension.
  92. enum LocalizationExtensionPurpose {
  93. # Extensions that are used for shipping purposes, for example, customs clearance.
  94. SHIPPING
  95. # Extensions that are used for taxes purposes, for example, invoicing.
  96. TAX
  97. }
  98. enum LocalizationExtensionKey {
  99. # Extension key 'tax_credential_br' for country BR.
  100. TAX_CREDENTIAL_BR
  101. # Extension key 'shipping_credential_br' for country BR.
  102. SHIPPING_CREDENTIAL_BR
  103. # Extension key 'shipping_credential_cn' for country CN.
  104. SHIPPING_CREDENTIAL_CN
  105. # Extension key 'tax_credential_it' for country IT.
  106. TAX_CREDENTIAL_IT
  107. # Extension key 'tax_email_it' for country IT.
  108. TAX_EMAIL_IT
  109. # Extension key 'shipping_credential_kr' for country KR.
  110. SHIPPING_CREDENTIAL_KR
  111. }
  112. # Represents the fallback avatar image for a staff member. This is used only if the staff member has no avatar image.
  113. enum StaffMemberDefaultImage {
  114. # Returns a default avatar image for the staff member.
  115. DEFAULT
  116. # Returns a transparent avatar image for the staff member.
  117. TRANSPARENT
  118. # Returns a URL that returns a 404 error if the image is not present.
  119. NOT_FOUND
  120. }
  121. # Possible metafield definition pinned statuses.
  122. enum MetafieldDefinitionPinnedStatus {
  123. # All metafield definitions.
  124. ANY
  125. # Only metafield definitions that are pinned.
  126. PINNED
  127. # Only metafield definitions that are not pinned.
  128. UNPINNED
  129. }
  130. # The set of valid sort keys for the MetafieldDefinition query.
  131. enum MetafieldDefinitionSortKeys {
  132. # Sort by the id value.
  133. ID
  134. # Sort by the name value.
  135. NAME
  136. # Sort by the pinned_position value.
  137. PINNED_POSITION
  138. # Sort by relevance to the search terms when the query parameter is specified on the connection.
  139. # Don't use this sort key when no search query is specified.
  140. RELEVANCE
  141. }
  142. # The set of valid sort keys for the CompanyContactRole query.
  143. enum CompanyContactRoleSortKeys {
  144. # Sort by the created_at value.
  145. CREATED_AT
  146. # Sort by the updated_at value.
  147. UPDATED_AT
  148. # Sort by the id value.
  149. ID
  150. # Sort by relevance to the search terms when the query parameter is specified on the connection.
  151. # Don't use this sort key when no search query is specified.
  152. RELEVANCE
  153. }
  154. # The set of valid sort keys for the CompanyContact query.
  155. enum CompanyContactSortKeys {
  156. # Sort by the created_at value.
  157. CREATED_AT
  158. # Sort by the updated_at value.
  159. UPDATED_AT
  160. # Sort by the title value.
  161. TITLE
  162. # Sort by the company_id value.
  163. COMPANY_ID
  164. # Sort by the name value.
  165. NAME
  166. # Sort by the email value.
  167. EMAIL
  168. # Sort by the name_email value.
  169. NAME_EMAIL
  170. ID
  171. # Sort by the id value.
  172. # Sort by relevance to the search terms when the query parameter is specified on the connection.
  173. # Don't use this sort key when no search query is specified.
  174. RELEVANCE
  175. }
  176. # The set of valid sort keys for the DraftOrder query.
  177. enum DraftOrderSortKeys {
  178. # Sort by the number value.
  179. NUMBER
  180. # Sort by the updated_at value.
  181. UPDATED_AT
  182. # Sort by the status value.
  183. STATUS
  184. # Sort by the total_price value.
  185. TOTAL_PRICE
  186. # Sort by the customer_name value.
  187. CUSTOMER_NAME
  188. # Sort by the id value.
  189. ID
  190. # Sort by relevance to the search terms when the query parameter is specified on the connection.
  191. # Don't use this sort key when no search query is specified.
  192. RELEVANCE
  193. }
  194. # The set of valid sort keys for the CompanyLocation query.
  195. enum CompanyLocationSortKeys {
  196. # Sort by the created_at value.
  197. CREATED_AT
  198. # Sort by the updated_at value.
  199. UPDATED_AT
  200. # Sort by the name value.
  201. NAME
  202. # Sort by the company_id value.
  203. COMPANY_ID
  204. # Sort by the company_and_location_name value.
  205. COMPANY_AND_LOCATION_NAME
  206. ID
  207. # Sort by the id value.
  208. # Sort by relevance to the search terms when the query parameter is specified on the connection.
  209. # Don't use this sort key when no search query is specified.
  210. RELEVANCE
  211. }
  212. # The set of valid sort keys for the Order query.
  213. enum OrderSortKeys {
  214. # Sort by the created_at value.
  215. CREATED_AT
  216. # Sort by the customer_name value.
  217. CUSTOMER_NAME
  218. # Sort by the financial_status value.
  219. FINANCIAL_STATUS
  220. # Sort by the fulfillment_status value.
  221. FULFILLMENT_STATUS
  222. # Sort by the order_number value.
  223. ORDER_NUMBER
  224. # Sort by the processed_at value.
  225. PROCESSED_AT
  226. # Sort by the total_price value.
  227. TOTAL_PRICE
  228. # Sort by the updated_at value.
  229. UPDATED_AT
  230. # Sort by the id value.
  231. ID
  232. # Sort by relevance to the search terms when the query parameter is specified on the connection.
  233. # Don't use this sort key when no search query is specified.
  234. RELEVANCE
  235. }
  236. # The set of valid sort keys for the CompanyContactRoleAssignment query.
  237. enum CompanyContactRoleAssignmentSortKeys {
  238. # Sort by the created_at value.
  239. CREATED_AT
  240. # Sort by the updated_at value.
  241. UPDATED_AT
  242. # Sort by the location_name value.
  243. LOCATION_NAME
  244. # Sort by the id value.
  245. ID
  246. # Sort by relevance to the search terms when the query parameter is specified on the connection.
  247. # Don't use this sort key when no search query is specified.
  248. RELEVANCE
  249. }
  250. # The possible values for the marketing subscription opt-in level enabled at the time the customer consented to receive marketing information.
  251. #
  252. # The levels are defined by the M3AAWG best practices guideline document.
  253. enum CustomerMarketingOptInLevel {
  254. # After providing their information, the customer receives marketing information without any
  255. # intermediate steps.
  256. SINGLE_OPT_IN
  257. # After providing their information, the customer receives a confirmation and is required to
  258. # perform a intermediate step before receiving marketing information.
  259. CONFIRMED_OPT_IN
  260. # The customer receives marketing information but how they were opted in is unknown.
  261. UNKNOWN
  262. }
  263. # The possible email marketing states for a customer.
  264. enum CustomerEmailMarketingState {
  265. # The customer isn't subscribed to email marketing.
  266. NOT_SUBSCRIBED
  267. # The customer is in the process of subscribing to email marketing.
  268. PENDING
  269. # The customer is subscribed to email marketing.
  270. SUBSCRIBED
  271. # The customer isn't currently subscribed to email marketing but was previously subscribed.
  272. UNSUBSCRIBED
  273. # The customer's personal data is erased. This value is internally-set and read-only.
  274. REDACTED
  275. # The customer’s email address marketing state is invalid.
  276. INVALID
  277. }
  278. # The possible product subscription states for a customer, as defined by the customer's subscription contracts.
  279. enum CustomerProductSubscriberStatus {
  280. # The customer has at least one active subscription contract.
  281. ACTIVE
  282. # The customer's last subscription contract was cancelled and there are no other active or paused
  283. # subscription contracts.
  284. CANCELLED
  285. # The customer's last subscription contract expired and there are no other active or paused
  286. # subscription contracts.
  287. EXPIRED
  288. # The customer's last subscription contract failed and there are no other active or paused
  289. # subscription contracts.
  290. FAILED
  291. # The customer has never had a subscription contract.
  292. NEVER_SUBSCRIBED
  293. # The customer has at least one paused subscription contract and there are no other active
  294. # subscription contracts.
  295. PAUSED
  296. }
  297. # The source that collected the customer's consent to receive marketing materials.
  298. enum CustomerConsentCollectedFrom {
  299. # The customer consent was collected by Shopify.
  300. SHOPIFY
  301. # The customer consent was collected outside of Shopify.
  302. OTHER
  303. }
  304. # The valid SMS marketing states for a customer’s phone number.
  305. enum CustomerSmsMarketingState {
  306. # The customer hasn't subscribed to SMS marketing.
  307. NOT_SUBSCRIBED
  308. # The customer is in the process of subscribing to SMS marketing.
  309. PENDING
  310. # The customer is subscribed to SMS marketing.
  311. SUBSCRIBED
  312. # The customer isn't currently subscribed to SMS marketing but was previously subscribed.
  313. UNSUBSCRIBED
  314. # The customer's personal data is erased. This value is internally-set and read-only.
  315. REDACTED
  316. }
  317. # The valid values for the state of a customer's account with a shop.
  318. enum CustomerState {
  319. # The customer declined the email invite to create an account.
  320. DECLINED
  321. # The customer doesn't have an active account. Customer accounts can be disabled from the Shopify admin at any time.
  322. DISABLED
  323. # The customer has created an account.
  324. ENABLED
  325. # The customer has received an email invite to create an account.
  326. INVITED
  327. }
  328. # The valid tiers for the predicted spend of a customer with a shop.
  329. enum CustomerPredictedSpendTier {
  330. # The customer's spend is higher than the 70th percentile of the shop's customer sales.
  331. HIGH
  332. # The customer's spend is between the 10th and 70th percentile of the shop's customer sales.
  333. MEDIUM
  334. # The customer's spend is lower than the 10th percentile of the shop's customer sales, including customers who didn't repurchase.
  335. LOW
  336. }
  337. # The valid statuses for a draft order.
  338. enum DraftOrderStatus {
  339. # The draft order has been paid.
  340. COMPLETED
  341. # An invoice for the draft order has been sent to the customer.
  342. INVOICE_SENT
  343. # The draft order is open. It has not been paid, and an invoice hasn't been sent.
  344. OPEN
  345. }
  346. # The valid discount types that can be applied to a draft order.
  347. enum DraftOrderAppliedDiscountType {
  348. # A fixed amount in the store's currency.
  349. FIXED_AMOUNT
  350. # A percentage of the order subtotal.
  351. PERCENTAGE
  352. }
  353. # The type of line (i.e. line item or shipping line) on an order that the discount is applicable towards.
  354. enum DiscountApplicationTargetType {
  355. # The discount applies onto line items.
  356. LINE_ITEM
  357. # The discount applies onto shipping lines.
  358. SHIPPING_LINE
  359. }
  360. # The lines on the order to which the discount is applied, of the type defined by
  361. # the discount application's targetType. For example, the value ENTITLED, combined with a targetType of
  362. # LINE_ITEM, applies the discount on all line items that are entitled to the discount.
  363. # The value ALL, combined with a targetType of SHIPPING_LINE, applies the discount on all shipping lines.
  364. enum DiscountApplicationTargetSelection {
  365. # The discount is allocated onto all the lines.
  366. ALL
  367. # The discount is allocated onto only the lines that it's entitled for.
  368. ENTITLED
  369. # The discount is allocated onto explicitly chosen lines.
  370. EXPLICIT
  371. }
  372. # The method by which the discount's value is allocated onto its entitled lines.
  373. enum DiscountApplicationAllocationMethod {
  374. # The value is spread across all entitled lines.
  375. ACROSS
  376. # The value is applied onto every entitled line.
  377. EACH
  378. }
  379. # The type of a fulfillment service.
  380. enum FulfillmentServiceType {
  381. # Fulfillment by gift card.
  382. GIFT_CARD
  383. # Manual fulfillment by the merchant.
  384. MANUAL
  385. # Fullfillment by a third-party fulfillment service.
  386. THIRD_PARTY
  387. }
  388. # The valid values for the inventory policy of a product variant once it is out of stock.
  389. enum ProductVariantInventoryPolicy {
  390. # Customers can't buy this product variant after it's out of stock.
  391. DENY
  392. # Customers can buy this product variant after it's out of stock.
  393. CONTINUE
  394. }
  395. # The set of valid sort keys for the Location query.
  396. enum LocationSortKeys {
  397. # Sort by the name value.
  398. NAME
  399. # Sort by the id value.
  400. ID
  401. # Sort by relevance to the search terms when the query parameter is specified on the connection.
  402. # Don't use this sort key when no search query is specified.
  403. RELEVANCE
  404. }
  405. # The type of a payment terms or a payment terms template.
  406. enum PaymentTermsType {
  407. # The payment terms or payment terms template is due on receipt.
  408. RECEIPT
  409. # The payment terms or payment terms template is a net type. It's due a number of days after issue.
  410. NET
  411. # The payment terms or payment terms template is a fixed type. It's due on a specified date.
  412. FIXED
  413. # The type of the payment terms or payment terms template is unknown.
  414. UNKNOWN
  415. }
  416. # The different types of method definitions to filter by.
  417. enum DeliveryMethodDefinitionType {
  418. # A static merchant-defined rate.
  419. MERCHANT
  420. # A dynamic participant rate.
  421. PARTICIPANT
  422. }
  423. # The set of valid sort keys for the MethodDefinition query.
  424. enum MethodDefinitionSortKeys {
  425. # Sort by the rate_provider_type value.
  426. RATE_PROVIDER_TYPE
  427. # Sort by the id value.
  428. ID
  429. # Sort by relevance to the search terms when the query parameter is specified on the connection.
  430. # Don't use this sort key when no search query is specified.
  431. RELEVANCE
  432. }
  433. # The field type that the condition will be applied to.
  434. enum DeliveryConditionField {
  435. # The condition will check against the total weight of the order.
  436. TOTAL_WEIGHT
  437. # The condition will check against the total price of the order.
  438. TOTAL_PRICE
  439. }
  440. # The operator to use to determine if the condition passes.
  441. enum DeliveryConditionOperator {
  442. # The condition will check whether the field is greater than or equal to the criterion.
  443. GREATER_THAN_OR_EQUAL_TO
  444. # The condition will check if the field is less than or equal to the criterion.
  445. LESS_THAN_OR_EQUAL_TO
  446. }
  447. # The category of the selling plan. For the OTHER category,
  448. # you must fill out our request form,
  449. # where we'll review your request for a new purchase option.
  450. enum SellingPlanCategory {
  451. # The selling plan is for anything not in one of the other categories.
  452. OTHER
  453. # The selling plan is for pre-orders.
  454. PRE_ORDER
  455. # The selling plan is for subscriptions.
  456. SUBSCRIPTION
  457. # The selling plan is for try before you buy purchases.
  458. TRY_BEFORE_YOU_BUY
  459. }
  460. # When to reserve inventory for a selling plan.
  461. enum SellingPlanReserve {
  462. # Reserve inventory when order is fulfilled.
  463. ON_FULFILLMENT
  464. # Reserve inventory at time of sale.
  465. ON_SALE
  466. }
  467. # The available icons for resource alerts.
  468. enum ResourceAlertIcon {
  469. # A checkmark inside a circle.
  470. CHECKMARK_CIRCLE
  471. # A lowercase i inside a circle.
  472. INFORMATION_CIRCLE
  473. }
  474. # The possible severity levels for a resource alert.
  475. enum ResourceAlertSeverity {
  476. # Indicates a neutral alert. For example, an accepted dispute.
  477. DEFAULT
  478. # Indicates an informative alert. For example, an escalated dispute.
  479. INFO
  480. # Indicates an informative alert. For example, a new dispute.
  481. WARNING
  482. # Indicates a success alert. For example, a winning a dispute.
  483. SUCCESS
  484. # Indicates a critical alert. For example, a blocked app.
  485. CRITICAL
  486. }
  487. # Represents the reason that the order is being canceled. Valid values are: customer, fraud, inventory, declined, other.
  488. enum OrderCancelReason {
  489. # The customer wanted to cancel the order.
  490. CUSTOMER
  491. # The order was fraudulent.
  492. FRAUD
  493. # There was insufficient inventory.
  494. INVENTORY
  495. # Payment was declined.
  496. DECLINED
  497. # Some other reason not listed.
  498. OTHER
  499. }
  500. # Possible types of app developer.
  501. enum AppDeveloperType {
  502. # Indicates the app developer is Shopify.
  503. SHOPIFY
  504. # Indicates the app developer is a Partner.
  505. PARTNER
  506. # Indicates the app developer works directly for a Merchant.
  507. MERCHANT
  508. # Indicates the app developer is unknown. It is not categorized as any of the other developer types.
  509. UNKNOWN
  510. }
  511. # The set of valid sort keys for the AppUsageRecord query.
  512. enum AppUsageRecordSortKeys {
  513. # Sort by the created_at value.
  514. CREATED_AT
  515. # Sort by the id value.
  516. ID
  517. # Sort by relevance to the search terms when the query parameter is specified on the connection.
  518. # Don't use this sort key when no search query is specified.
  519. RELEVANCE
  520. }
  521. # The status of the app subscription.
  522. enum AppSubscriptionStatus {
  523. # The app subscription is pending approval by the merchant.
  524. PENDING
  525. # The app subscription has been approved by the merchant. Active app subscriptions are billed to the shop.
  526. # After payment, partners receive payouts.
  527. ACTIVE
  528. # The app subscription was declined by the merchant. This is a terminal state.
  529. DECLINED
  530. # The app subscription wasn't approved by the merchant within two days of being created. This is a terminal state.
  531. EXPIRED
  532. # The app subscription is on hold due to non-payment. The subscription re-activates after payments resume.
  533. FROZEN
  534. # The app subscription was cancelled by the app. This could be caused by the app being uninstalled,
  535. # a new app subscription being activated, or a direct cancellation by the app. This is a terminal state.
  536. CANCELLED
  537. }
  538. # The public-facing category for an app.
  539. enum AppPublicCategory {
  540. # The app's public category is private.
  541. PRIVATE
  542. # The app's public category is public.
  543. PUBLIC
  544. # The app's public category is custom.
  545. CUSTOM
  546. # The app's public category is other. An app is in this category if it's not classified under any of the other app types
  547. # (private, public, or custom).
  548. OTHER
  549. }
  550. # The set of valid sort keys for the AppSubscription query.
  551. enum AppSubscriptionSortKeys {
  552. # Sort by the created_at value.
  553. CREATED_AT
  554. # Sort by the id value.
  555. ID
  556. # Sort by relevance to the search terms when the query parameter is specified on the connection.
  557. # Don't use this sort key when no search query is specified.
  558. RELEVANCE
  559. }
  560. # The set of valid sort keys for the AppTransaction query.
  561. enum AppTransactionSortKeys {
  562. # Sort by the created_at value.
  563. CREATED_AT
  564. # Sort by the id value.
  565. ID
  566. # Sort by relevance to the search terms when the query parameter is specified on the connection.
  567. # Don't use this sort key when no search query is specified.
  568. RELEVANCE
  569. }
  570. # The set of valid sort keys for the AppRevenueAttributionRecord query.
  571. enum AppRevenueAttributionRecordSortKeys {
  572. # Sort by the created_at value.
  573. CREATED_AT
  574. # Sort by the id value.
  575. ID
  576. # Sort by relevance to the search terms when the query parameter is specified on the connection.
  577. # Don't use this sort key when no search query is specified.
  578. RELEVANCE
  579. }
  580. # The approval status of the app purchase.
  581. #
  582. # The merchant is charged for the purchase immediately after approval, and the status changes to active.
  583. # If the payment fails, then the app purchase remains pending.
  584. #
  585. # Purchases start as pending and can change to: active, declined, expired. After a purchase changes, it
  586. # remains in that final state.
  587. enum AppPurchaseStatus {
  588. # The app purchase was approved by the merchant and has been activated by the app.
  589. # Active app purchases are charged to the merchant and are paid out to the partner.
  590. ACTIVE
  591. # The app purchase was declined by the merchant.
  592. DECLINED
  593. # The app purchase was not accepted within two days of being created.
  594. EXPIRED
  595. # The app purchase is pending approval by the merchant.
  596. PENDING
  597. }
  598. # Represents the billing types of revenue attribution.
  599. enum AppRevenueAttributionType {
  600. # App purchase related revenue collection.
  601. APPLICATION_PURCHASE
  602. # App subscription revenue collection.
  603. APPLICATION_SUBSCRIPTION
  604. # App usage-based revenue collection.
  605. APPLICATION_USAGE
  606. # Other app revenue collection type.
  607. OTHER
  608. }
  609. # Specifies the sort order for the products in the collection.
  610. enum CollectionSortOrder {
  611. # Alphabetically, in ascending order (A - Z).
  612. ALPHA_ASC
  613. # Alphabetically, in descending order (Z - A).
  614. ALPHA_DESC
  615. # By best-selling products.
  616. BEST_SELLING
  617. # By date created, in ascending order (oldest - newest).
  618. CREATED
  619. # By date created, in descending order (newest - oldest).
  620. CREATED_DESC
  621. # In the order set manually by the merchant.
  622. MANUAL
  623. # By price, in ascending order (lowest - highest).
  624. PRICE_ASC
  625. # By price, in descending order (highest - lowest).
  626. PRICE_DESC
  627. }
  628. # The set of valid sort keys for the ProductCollection query.
  629. enum ProductCollectionSortKeys {
  630. # Sort by the title value.
  631. TITLE
  632. # Sort by the price value.
  633. PRICE
  634. # Sort by the best-selling value.
  635. BEST_SELLING
  636. # Sort by the created value.
  637. CREATED
  638. # Sort by the id value.
  639. ID
  640. # Sort by the manual value.
  641. MANUAL
  642. # Sort by the collection-default value.
  643. COLLECTION_DEFAULT
  644. # Sort by relevance to the search terms when the query parameter is specified on the connection.
  645. # Don't use this sort key when no search query is specified.
  646. RELEVANCE
  647. }
  648. # A standardized error code, independent of the payment provider.
  649. enum OrderTransactionErrorCode {
  650. # The card number is incorrect.
  651. INCORRECT_NUMBER
  652. # The format of the card number is incorrect.
  653. INVALID_NUMBER
  654. # The format of the expiry date is incorrect.
  655. INVALID_EXPIRY_DATE
  656. # The format of the CVC is incorrect.
  657. INVALID_CVC
  658. # The card is expired.
  659. EXPIRED_CARD
  660. # The CVC does not match the card number.
  661. INCORRECT_CVC
  662. # The ZIP or postal code does not match the card number.
  663. INCORRECT_ZIP
  664. INCORRECT_ADDRESS
  665. # The address does not match the card number.
  666. # The entered PIN is incorrect.
  667. INCORRECT_PIN
  668. # The card was declined.
  669. CARD_DECLINED
  670. # There was an error while processing the payment.
  671. PROCESSING_ERROR
  672. # Call the card issuer.
  673. CALL_ISSUER
  674. # The card has been reported as lost or stolen, and the card issuer has requested that the merchant keep the card and call the number on the back.
  675. PICK_UP_CARD
  676. CONFIG_ERROR
  677. # There is an error in the gateway or merchant configuration.
  678. # A real card was used but the gateway was in test mode.
  679. TEST_MODE_LIVE_CARD
  680. # The gateway or merchant configuration doesn't support a feature, such as network tokenization.
  681. UNSUPPORTED_FEATURE
  682. # There was an unknown error with processing the payment.
  683. GENERIC_ERROR
  684. # The payment method is not available in the customer's country.
  685. INVALID_COUNTRY
  686. # The amount is either too high or too low for the provider.
  687. INVALID_AMOUNT
  688. # The payment method is momentarily unavailable.
  689. PAYMENT_METHOD_UNAVAILABLE
  690. # The payment method was invalid.
  691. AMAZON_PAYMENTS_INVALID_PAYMENT_METHOD
  692. # The maximum amount has been captured.
  693. AMAZON_PAYMENTS_MAX_AMOUNT_CHARGED
  694. # The maximum amount has been refunded.
  695. AMAZON_PAYMENTS_MAX_AMOUNT_REFUNDED
  696. # The maximum of 10 authorizations has been captured for an order.
  697. AMAZON_PAYMENTS_MAX_AUTHORIZATIONS_CAPTURED
  698. # The maximum of 10 refunds has been processed for an order.
  699. AMAZON_PAYMENTS_MAX_REFUNDS_PROCESSED
  700. # The order was canceled, which canceled all open authorizations.
  701. AMAZON_PAYMENTS_ORDER_REFERENCE_CANCELED
  702. # The order was not confirmed within three hours.
  703. AMAZON_PAYMENTS_STALE
  704. }
  705. # The different kinds of order transactions.
  706. enum OrderTransactionKind {
  707. # An authorization and capture performed together in a single step.
  708. SALE
  709. # A transfer of the money that was reserved by an authorization.
  710. CAPTURE
  711. # An amount reserved against the cardholder's funding source.
  712. # Money does not change hands until the authorization is captured.
  713. AUTHORIZATION
  714. # A cancelation of an authorization transaction.
  715. VOID
  716. # A partial or full return of captured funds to the cardholder.
  717. # A refund can happen only after a capture is processed.
  718. REFUND
  719. # The money returned to the customer when they've paid too much during a cash transaction.
  720. CHANGE
  721. # An authorization for a payment taken with an EMV credit card reader.
  722. EMV_AUTHORIZATION
  723. # A suggested refund transaction that can be used to create a refund.
  724. SUGGESTED_REFUND
  725. }
  726. # The different states that an OrderTransaction can have.
  727. enum OrderTransactionStatus {
  728. # The transaction succeeded.
  729. SUCCESS
  730. # The transaction failed.
  731. FAILURE
  732. # The transaction is pending.
  733. PENDING
  734. # There was an error while processing the transaction.
  735. ERROR
  736. # Awaiting a response.
  737. AWAITING_RESPONSE
  738. # The transaction status is unknown.
  739. UNKNOWN
  740. }
  741. # The available types of marketing event.
  742. enum MarketingTactic {
  743. ABANDONED_CART
  744. # An abandoned cart recovery email.
  745. # An ad, such as a Facebook ad.
  746. AD
  747. # An affiliate link.
  748. AFFILIATE
  749. # A link.
  750. LINK
  751. # A loyalty program.
  752. LOYALTY
  753. # A messaging app, such as Facebook Messenger.
  754. MESSAGE
  755. # A newsletter.
  756. NEWSLETTER
  757. # A notification in the Shopify admin.
  758. NOTIFICATION
  759. # A blog post.
  760. POST
  761. # A retargeting ad.
  762. RETARGETING
  763. # A transactional email.
  764. TRANSACTIONAL
  765. # Search engine optimization.
  766. SEO
  767. # A direct visit to the online store.
  768. DIRECT
  769. # A popup on the online store.
  770. STOREFRONT_APP
  771. }
  772. # The available marketing channels for a marketing activity or event.
  773. # A marketing channel is broad category of marketing, used for reporting aggregation.
  774. enum MarketingChannel {
  775. # Paid search.
  776. SEARCH
  777. # Displayed ads.
  778. DISPLAY
  779. # Social media.
  780. SOCIAL
  781. # Email.
  782. EMAIL
  783. # Referral links.
  784. REFERRAL
  785. }
  786. # Specifies the kind of the suggested order transaction.
  787. enum SuggestedOrderTransactionKind {
  788. # A suggested refund transaction for an order.
  789. SUGGESTED_REFUND
  790. }
  791. enum RefundLineItemRestockType {
  792. # The refund line item was returned. Use this when restocking line items that were fulfilled.
  793. RETURN
  794. # The refund line item was canceled. Use this when restocking unfulfilled line items.
  795. CANCEL
  796. # Deprecated.
  797. # The refund line item was restocked, without specifically being identified as a return or cancelation.
  798. # This value is not accepted when creating new refunds.
  799. LEGACY_RESTOCK
  800. # Refund line item was not restocked.
  801. NO_RESTOCK
  802. }
  803. # The reason a discount on a subscription draft was rejected.
  804. enum SubscriptionDiscountRejectionReason {
  805. # Discount code is not found.
  806. NOT_FOUND
  807. # Discount does not apply to any of the given line items.
  808. NO_ENTITLED_LINE_ITEMS
  809. # Quantity of items does not qualify for the discount.
  810. QUANTITY_NOT_IN_RANGE
  811. # Purchase amount of items does not qualify for the discount.
  812. PURCHASE_NOT_IN_RANGE
  813. # Given customer does not qualify for the discount.
  814. CUSTOMER_NOT_ELIGIBLE
  815. # Discount usage limit has been reached.
  816. USAGE_LIMIT_REACHED
  817. # Customer usage limit has been reached.
  818. CUSTOMER_USAGE_LIMIT_REACHED
  819. # Discount is inactive.
  820. CURRENTLY_INACTIVE
  821. # No applicable shipping lines.
  822. NO_ENTITLED_SHIPPING_LINES
  823. # Purchase type does not qualify for the discount.
  824. INCOMPATIBLE_PURCHASE_TYPE
  825. # Internal error during discount code validation.
  826. INTERNAL_ERROR
  827. }
  828. # The revocation reason types for a customer payment method.
  829. enum CustomerPaymentMethodRevocationReason {
  830. # The Authorize.net payment gateway is not enabled.
  831. AUTHORIZE_NET_GATEWAY_NOT_ENABLED
  832. # Authorize.net did not return any payment methods. Make sure that the correct Authorize.net account is linked.
  833. AUTHORIZE_NET_RETURNED_NO_PAYMENT_METHOD
  834. # The credit card failed to update.
  835. FAILED_TO_UPDATE_CREDIT_CARD
  836. # Failed to contact the Stripe API.
  837. STRIPE_API_AUTHENTICATION_ERROR
  838. # Invalid request. Failed to retrieve payment method from Stripe.
  839. STRIPE_API_INVALID_REQUEST_ERROR
  840. # The Stripe payment gateway is not enabled.
  841. STRIPE_GATEWAY_NOT_ENABLED
  842. # Stripe did not return any payment methods. Make sure that the correct Stripe account is linked.
  843. STRIPE_RETURNED_NO_PAYMENT_METHOD
  844. # The Stripe payment method type should be card.
  845. STRIPE_PAYMENT_METHOD_NOT_CARD
  846. # Failed to contact Braintree API.
  847. BRAINTREE_API_AUTHENTICATION_ERROR
  848. # The Braintree payment gateway is not enabled.
  849. BRAINTREE_GATEWAY_NOT_ENABLED
  850. # Braintree returned no payment methods. Make sure the correct Braintree account is linked.
  851. BRAINTREE_RETURNED_NO_PAYMENT_METHOD
  852. # The Braintree payment method type should be a credit card or Apple Pay card.
  853. BRAINTREE_PAYMENT_METHOD_NOT_CARD
  854. # The payment method was manually revoked.
  855. MANUALLY_REVOKED
  856. # The payment method was replaced with an existing payment method.
  857. # The associated contracts have been migrated to the other payment method.
  858. MERGED
  859. }
  860. # The possible status values of a subscription.
  861. enum SubscriptionContractSubscriptionStatus {
  862. # The contract is active and continuing per its policies.
  863. ACTIVE
  864. # The contract is temporarily paused and is expected to resume in the future.
  865. PAUSED
  866. # The contract was ended by an unplanned customer action.
  867. CANCELLED
  868. # The contract has ended per the expected circumstances.
  869. # All billing and delivery cycles of the subscriptions were executed.
  870. EXPIRED
  871. # The contract ended because billing failed and no further billing attempts are expected.
  872. FAILED
  873. }
  874. # The possible status values of the last payment on a subscription contract.
  875. enum SubscriptionContractLastPaymentStatus {
  876. # Successful subscription billing attempt.
  877. SUCCEEDED
  878. # Failed subscription billing attempt.
  879. FAILED
  880. }
  881. # Available customer tax exemptions.
  882. enum TaxExemption {
  883. # This customer is exempt from specific taxes for holding a valid STATUS_CARD_EXEMPTION in Canada.
  884. CA_STATUS_CARD_EXEMPTION
  885. # This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in British Columbia.
  886. CA_BC_RESELLER_EXEMPTION
  887. # This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Manitoba.
  888. CA_MB_RESELLER_EXEMPTION
  889. # This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Saskatchewan.
  890. CA_SK_RESELLER_EXEMPTION
  891. # This customer is exempt from specific taxes for holding a valid DIPLOMAT_EXEMPTION in Canada.
  892. CA_DIPLOMAT_EXEMPTION
  893. # This customer is exempt from specific taxes for holding a valid COMMERCIAL_FISHERY_EXEMPTION in British Columbia.
  894. CA_BC_COMMERCIAL_FISHERY_EXEMPTION
  895. # This customer is exempt from specific taxes for holding a valid COMMERCIAL_FISHERY_EXEMPTION in Manitoba.
  896. CA_MB_COMMERCIAL_FISHERY_EXEMPTION
  897. # This customer is exempt from specific taxes for holding a valid COMMERCIAL_FISHERY_EXEMPTION in Nova Scotia.
  898. CA_NS_COMMERCIAL_FISHERY_EXEMPTION
  899. # This customer is exempt from specific taxes for holding a valid COMMERCIAL_FISHERY_EXEMPTION in Prince Edward Island.
  900. CA_PE_COMMERCIAL_FISHERY_EXEMPTION
  901. # This customer is exempt from specific taxes for holding a valid COMMERCIAL_FISHERY_EXEMPTION in Saskatchewan.
  902. CA_SK_COMMERCIAL_FISHERY_EXEMPTION
  903. # This customer is exempt from specific taxes for holding a valid PRODUCTION_AND_MACHINERY_EXEMPTION in British Columbia.
  904. CA_BC_PRODUCTION_AND_MACHINERY_EXEMPTION
  905. # This customer is exempt from specific taxes for holding a valid PRODUCTION_AND_MACHINERY_EXEMPTION in Saskatchewan.
  906. CA_SK_PRODUCTION_AND_MACHINERY_EXEMPTION
  907. # This customer is exempt from specific taxes for holding a valid SUB_CONTRACTOR_EXEMPTION in British Columbia.
  908. CA_BC_SUB_CONTRACTOR_EXEMPTION
  909. # This customer is exempt from specific taxes for holding a valid SUB_CONTRACTOR_EXEMPTION in Saskatchewan.
  910. CA_SK_SUB_CONTRACTOR_EXEMPTION
  911. # This customer is exempt from specific taxes for holding a valid CONTRACTOR_EXEMPTION in British Columbia.
  912. CA_BC_CONTRACTOR_EXEMPTION
  913. # This customer is exempt from specific taxes for holding a valid CONTRACTOR_EXEMPTION in Saskatchewan.
  914. CA_SK_CONTRACTOR_EXEMPTION
  915. # This customer is exempt from specific taxes for holding a valid PURCHASE_EXEMPTION in Ontario.
  916. CA_ON_PURCHASE_EXEMPTION
  917. # This customer is exempt from specific taxes for holding a valid FARMER_EXEMPTION in Manitoba.
  918. CA_MB_FARMER_EXEMPTION
  919. # This customer is exempt from specific taxes for holding a valid FARMER_EXEMPTION in Nova Scotia.
  920. CA_NS_FARMER_EXEMPTION
  921. # This customer is exempt from specific taxes for holding a valid FARMER_EXEMPTION in Saskatchewan.
  922. CA_SK_FARMER_EXEMPTION
  923. # This customer is exempt from VAT for purchases within the EU that is shipping from outside of customer's country.
  924. EU_REVERSE_CHARGE_EXEMPTION_RULE
  925. # This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Alabama.
  926. US_AL_RESELLER_EXEMPTION
  927. # This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Alaska.
  928. US_AK_RESELLER_EXEMPTION
  929. # This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Arizona.
  930. US_AZ_RESELLER_EXEMPTION
  931. # This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Arkansas.
  932. US_AR_RESELLER_EXEMPTION
  933. # This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in California.
  934. US_CA_RESELLER_EXEMPTION
  935. # This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Colorado.
  936. US_CO_RESELLER_EXEMPTION
  937. # This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Connecticut.
  938. US_CT_RESELLER_EXEMPTION
  939. # This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Delaware.
  940. US_DE_RESELLER_EXEMPTION
  941. # This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Florida.
  942. US_FL_RESELLER_EXEMPTION
  943. # This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Georgia.
  944. US_GA_RESELLER_EXEMPTION
  945. # This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Hawaii.
  946. US_HI_RESELLER_EXEMPTION
  947. # This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Idaho.
  948. US_ID_RESELLER_EXEMPTION
  949. # This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Illinois.
  950. US_IL_RESELLER_EXEMPTION
  951. # This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Indiana.
  952. US_IN_RESELLER_EXEMPTION
  953. # This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Iowa.
  954. US_IA_RESELLER_EXEMPTION
  955. # This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Kansas.
  956. US_KS_RESELLER_EXEMPTION
  957. # This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Kentucky.
  958. US_KY_RESELLER_EXEMPTION
  959. # This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Louisiana.
  960. US_LA_RESELLER_EXEMPTION
  961. # This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Maine.
  962. US_ME_RESELLER_EXEMPTION
  963. # This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Maryland.
  964. US_MD_RESELLER_EXEMPTION
  965. # This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Massachusetts.
  966. US_MA_RESELLER_EXEMPTION
  967. # This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Michigan.
  968. US_MI_RESELLER_EXEMPTION
  969. # This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Minnesota.
  970. US_MN_RESELLER_EXEMPTION
  971. # This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Mississippi.
  972. US_MS_RESELLER_EXEMPTION
  973. # This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Missouri.
  974. US_MO_RESELLER_EXEMPTION
  975. # This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Montana.
  976. US_MT_RESELLER_EXEMPTION
  977. # This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Nebraska.
  978. US_NE_RESELLER_EXEMPTION
  979. # This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Nevada.
  980. US_NV_RESELLER_EXEMPTION
  981. # This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in New Hampshire.
  982. US_NH_RESELLER_EXEMPTION
  983. # This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in New Jersey.
  984. US_NJ_RESELLER_EXEMPTION
  985. # This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in New Mexico.
  986. US_NM_RESELLER_EXEMPTION
  987. # This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in New York.
  988. US_NY_RESELLER_EXEMPTION
  989. # This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in North Carolina.
  990. US_NC_RESELLER_EXEMPTION
  991. # This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in North Dakota.
  992. US_ND_RESELLER_EXEMPTION
  993. # This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Ohio.
  994. US_OH_RESELLER_EXEMPTION
  995. # This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Oklahoma.
  996. US_OK_RESELLER_EXEMPTION
  997. # This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Oregon.
  998. US_OR_RESELLER_EXEMPTION
  999. # This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Pennsylvania.
  1000. US_PA_RESELLER_EXEMPTION
  1001. # This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Rhode Island.
  1002. US_RI_RESELLER_EXEMPTION
  1003. # This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in South Carolina.
  1004. US_SC_RESELLER_EXEMPTION
  1005. # This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in South Dakota.
  1006. US_SD_RESELLER_EXEMPTION
  1007. # This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Tennessee.
  1008. US_TN_RESELLER_EXEMPTION
  1009. # This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Texas.
  1010. US_TX_RESELLER_EXEMPTION
  1011. # This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Utah.
  1012. US_UT_RESELLER_EXEMPTION
  1013. # This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Vermont.
  1014. US_VT_RESELLER_EXEMPTION
  1015. # This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Virginia.
  1016. US_VA_RESELLER_EXEMPTION
  1017. # This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Washington.
  1018. US_WA_RESELLER_EXEMPTION
  1019. # This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in West Virginia.
  1020. US_WV_RESELLER_EXEMPTION
  1021. # This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Wisconsin.
  1022. US_WI_RESELLER_EXEMPTION
  1023. # This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Wyoming.
  1024. US_WY_RESELLER_EXEMPTION
  1025. # This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Washington DC.
  1026. US_DC_RESELLER_EXEMPTION
  1027. }
  1028. # Represents valid selling plan interval.
  1029. enum SellingPlanInterval {
  1030. # Day interval.
  1031. DAY
  1032. # Week interval.
  1033. WEEK
  1034. # Month interval.
  1035. MONTH
  1036. # Year interval.
  1037. YEAR
  1038. }
  1039. # Represents the anchor type.
  1040. enum SellingPlanAnchorType {
  1041. # Which day of the week, between 1-7.
  1042. WEEKDAY
  1043. # Which day of the month, between 1-31.
  1044. MONTHDAY
  1045. # Which days of the month and year, month between 1-12, and day between 1-31.
  1046. YEARDAY
  1047. }
  1048. # Represents a selling plan pricing policy adjustment type.
  1049. enum SellingPlanPricingPolicyAdjustmentType {
  1050. # Percentage off adjustment.
  1051. PERCENTAGE
  1052. # Fixed amount off adjustment.
  1053. FIXED_AMOUNT
  1054. # Price of the policy.
  1055. PRICE
  1056. }
  1057. # The type of line (line item or shipping line) on an order that the subscription discount is applicable towards.
  1058. enum DiscountTargetType {
  1059. # The discount applies onto line items.
  1060. LINE_ITEM
  1061. # The discount applies onto shipping lines.
  1062. SHIPPING_LINE
  1063. }
  1064. # The type of the subscription discount.
  1065. enum DiscountType {
  1066. # Manual discount type.
  1067. MANUAL
  1068. # Code discount type.
  1069. CODE_DISCOUNT
  1070. }
  1071. # The type of refund to perform for a particular refund duty.
  1072. enum RefundDutyRefundType {
  1073. # The duty is proportionally refunded based on the quantity of the refunded line item.
  1074. PROPORTIONAL
  1075. # The duty is fully refunded.
  1076. FULL
  1077. }
  1078. # The likelihood that an order is fraudulent.
  1079. enum OrderRiskLevel {
  1080. # There is a low level of risk that this order is fraudulent.
  1081. LOW
  1082. # There is a medium level of risk that this order is fraudulent.
  1083. MEDIUM
  1084. # There is a high level of risk that this order is fraudulent.
  1085. HIGH
  1086. }
  1087. # The set of valid sort keys for the FulfillmentEvent query.
  1088. enum FulfillmentEventSortKeys {
  1089. # Sort by the happened_at value.
  1090. HAPPENED_AT
  1091. # Sort by the id value.
  1092. ID
  1093. # Sort by relevance to the search terms when the query parameter is specified on the connection.
  1094. # Don't use this sort key when no search query is specified.
  1095. RELEVANCE
  1096. }
  1097. # The display status of a fulfillment.
  1098. enum FulfillmentDisplayStatus {
  1099. # Displayed as Attempted delivery.
  1100. ATTEMPTED_DELIVERY
  1101. # Displayed as Canceled.
  1102. CANCELED
  1103. # Displayed as Confirmed.
  1104. CONFIRMED
  1105. # Displayed as Delivered.
  1106. DELIVERED
  1107. # Displayed as Failure.
  1108. FAILURE
  1109. # Displayed as Fulfilled.
  1110. FULFILLED
  1111. # Displayed as In transit.
  1112. IN_TRANSIT
  1113. # Displayed as Label printed.
  1114. LABEL_PRINTED
  1115. # Displayed as Label purchased.
  1116. LABEL_PURCHASED
  1117. # Displayed as Label voided.
  1118. LABEL_VOIDED
  1119. # Displayed as Marked as fulfilled.
  1120. MARKED_AS_FULFILLED
  1121. # Displayed as Not delivered.
  1122. NOT_DELIVERED
  1123. # Displayed as Out for delivery.
  1124. OUT_FOR_DELIVERY
  1125. # Displayed as Ready for pickup.
  1126. READY_FOR_PICKUP
  1127. # Displayed as Picked up.
  1128. PICKED_UP
  1129. # Displayed as Submitted.
  1130. SUBMITTED
  1131. }
  1132. # The status of a fulfillment.
  1133. enum FulfillmentStatus {
  1134. # The fulfillment was completed successfully.
  1135. SUCCESS
  1136. # The fulfillment was canceled.
  1137. CANCELLED
  1138. # There was an error with the fulfillment request.
  1139. ERROR
  1140. # The fulfillment request failed.
  1141. FAILURE
  1142. }
  1143. # The possible types for a dispute.
  1144. enum DisputeType {
  1145. # The dispute has turned into a chargeback.
  1146. CHARGEBACK
  1147. # The dispute is in the inquiry phase.
  1148. INQUIRY
  1149. }
  1150. # The possible statuses of a dispute.
  1151. enum DisputeStatus {
  1152. NEEDS_RESPONSE
  1153. UNDER_REVIEW
  1154. CHARGE_REFUNDED
  1155. ACCEPTED
  1156. WON
  1157. LOST
  1158. }
  1159. # Represents the order's current financial status.
  1160. enum OrderDisplayFinancialStatus {
  1161. # Displayed as Pending.
  1162. PENDING
  1163. # Displayed as Authorized.
  1164. AUTHORIZED
  1165. # Displayed as Partially paid.
  1166. PARTIALLY_PAID
  1167. # Displayed as Partially refunded.
  1168. PARTIALLY_REFUNDED
  1169. # Displayed as Voided.
  1170. VOIDED
  1171. # Displayed as Paid.
  1172. PAID
  1173. # Displayed as Refunded.
  1174. REFUNDED
  1175. # Displayed as Expired.
  1176. EXPIRED
  1177. }
  1178. # Represents the order's aggregated fulfillment status for display purposes.
  1179. enum OrderDisplayFulfillmentStatus {
  1180. # Displayed as Unfulfilled. None of the items in the order have been fulfilled.
  1181. UNFULFILLED
  1182. # Displayed as Partially fulfilled. Some of the items in the order have been fulfilled.
  1183. PARTIALLY_FULFILLED
  1184. # Displayed as Fulfilled. All the items in the order have been fulfilled.
  1185. FULFILLED
  1186. # Displayed as Restocked. All the items in the order have been restocked. Replaced by the "UNFULFILLED" status.
  1187. RESTOCKED
  1188. # Displayed as Pending fulfillment. A request for fulfillment of some items awaits a response from the fulfillment service. Replaced by the "IN_PROGRESS" status.
  1189. PENDING_FULFILLMENT
  1190. # Displayed as Open. None of the items in the order have been fulfilled. Replaced by "UNFULFILLED" status.
  1191. OPEN
  1192. # Displayed as In progress.
  1193. # Some of the items in the order have been fulfilled, or a request for fulfillment has been sent to the fulfillment service.
  1194. IN_PROGRESS
  1195. # Displayed as On hold. All of the unfulfilled items in this order are on hold.
  1196. ON_HOLD
  1197. # Displayed as Scheduled. All of the unfulfilled items in this order are scheduled for fulfillment at later time.
  1198. SCHEDULED
  1199. }
  1200. # The possible order action types for a sales agreement.
  1201. enum OrderActionType {
  1202. # An order with a purchase or charge.
  1203. ORDER
  1204. # An edit to the order.
  1205. ORDER_EDIT
  1206. # A refund on the order.
  1207. REFUND
  1208. # An unknown agreement action. Represents new actions that may be added in future versions.
  1209. UNKNOWN
  1210. }
  1211. enum SaleActionType {
  1212. # A purchase or charge.
  1213. ORDER
  1214. # A removal or return.
  1215. RETURN
  1216. # A change to the price, taxes, or discounts for a prior purchase.
  1217. UPDATE
  1218. # An unknown order action. Represents new actions that may be added in future versions.
  1219. UNKNOWN
  1220. }
  1221. # The possible line types for a sale record.
  1222. # One of the possible order line types for a sale is an adjustment.
  1223. # Sales adjustments occur when a refund is issued for a line item that is either more or less than the total value of the line item.
  1224. # Examples are restocking fees and goodwill payments.
  1225. # When this happens, Shopify produces a sales agreement with sale records for each line item that is returned or refunded and an additional sale record for the adjustment (for example, a restocking fee).
  1226. # The sales records for the returned or refunded items represent the reversal of the original line item sale value.
  1227. # The additional adjustment sale record represents the difference between the original total value of all line items that were refunded, and the actual amount refunded.
  1228. enum SaleLineType {
  1229. # A product purchased, returned or exchanged.
  1230. PRODUCT
  1231. # A tip added by the customer.
  1232. TIP
  1233. # A gift card.
  1234. GIFT_CARD
  1235. # A shipping cost.
  1236. SHIPPING
  1237. # A duty charge.
  1238. DUTY
  1239. # An unknown sale line. Represents new types that may be added in future versions.
  1240. UNKNOWN
  1241. # A sale adjustment.
  1242. ADJUSTMENT
  1243. }
  1244. # The possible error codes associated with making billing attempts. The error codes supplement the
  1245. # error_message to provide consistent results and help with dunning management.
  1246. enum SubscriptionBillingAttemptErrorCode {
  1247. # Payment method was not found.
  1248. PAYMENT_METHOD_NOT_FOUND
  1249. # Payment provider is not enabled.
  1250. PAYMENT_PROVIDER_IS_NOT_ENABLED
  1251. # Payment method is invalid. Please update or create a new payment method.
  1252. INVALID_PAYMENT_METHOD
  1253. # There was an unexpected error during the billing attempt.
  1254. UNEXPECTED_ERROR
  1255. # Payment method is expired.
  1256. EXPIRED_PAYMENT_METHOD
  1257. # Payment method was declined by processor.
  1258. PAYMENT_METHOD_DECLINED
  1259. # There was an error during the authentication.
  1260. AUTHENTICATION_ERROR
  1261. # Gateway is in test mode and attempted to bill a live payment method.
  1262. TEST_MODE
  1263. # Payment method was canceled by buyer.
  1264. BUYER_CANCELED_PAYMENT_METHOD
  1265. # Customer was not found.
  1266. CUSTOMER_NOT_FOUND
  1267. # Customer is invalid.
  1268. CUSTOMER_INVALID
  1269. # The shipping address is either missing or invalid.
  1270. INVALID_SHIPPING_ADDRESS
  1271. # The billing agreement ID or the transaction ID for the customer's payment method is invalid.
  1272. INVALID_CUSTOMER_BILLING_AGREEMENT
  1273. # A payment has already been made for this invoice.
  1274. INVOICE_ALREADY_PAID
  1275. # Payment method cannot be used with the current payment gateway test mode configuration.
  1276. PAYMENT_METHOD_INCOMPATIBLE_WITH_GATEWAY_CONFIG
  1277. # The amount is too small.
  1278. AMOUNT_TOO_SMALL
  1279. }
  1280. # Possible method types that a delivery method can have.
  1281. enum DeliveryMethodType {
  1282. # The order is shipped.
  1283. SHIPPING
  1284. # The order is picked up by the customer.
  1285. PICK_UP
  1286. # No delivery is needed.
  1287. NONE
  1288. # The order is delivered to a retail store.
  1289. RETAIL
  1290. # The order is delivered using a local delivery service.
  1291. LOCAL
  1292. }
  1293. # The reason for a fulfillment hold.
  1294. enum FulfillmentHoldReason {
  1295. # The fulfillment hold is applied because payment is pending.
  1296. AWAITING_PAYMENT
  1297. # The fulfillment hold is applied because of a high risk of fraud.
  1298. HIGH_RISK_OF_FRAUD
  1299. # The fulfillment hold is applied because of an incorrect address.
  1300. INCORRECT_ADDRESS
  1301. # The fulfillment hold is applied because inventory is out of stock.
  1302. INVENTORY_OUT_OF_STOCK
  1303. # The fulfillment hold is applied because of an unknown delivery date.
  1304. UNKNOWN_DELIVERY_DATE
  1305. # The fulfillment hold is applied for another reason.
  1306. OTHER
  1307. }
  1308. # The kinds of request merchants can make to a fulfillment service.
  1309. enum FulfillmentOrderMerchantRequestKind {
  1310. # The merchant requests fulfillment for an OPEN fulfillment order.
  1311. FULFILLMENT_REQUEST
  1312. # The merchant requests cancellation of an IN_PROGRESS fulfillment order.
  1313. CANCELLATION_REQUEST
  1314. }
  1315. # The request status of a fulfillment order.
  1316. enum FulfillmentOrderRequestStatus {
  1317. # The initial request status for the newly-created fulfillment orders. This is the only valid
  1318. # request status for fulfillment orders that aren't assigned to a fulfillment service.
  1319. UNSUBMITTED
  1320. # The merchant requested fulfillment for this fulfillment order.
  1321. SUBMITTED
  1322. # The fulfillment service accepted the merchant's fulfillment request.
  1323. ACCEPTED
  1324. # The fulfillment service rejected the merchant's fulfillment request.
  1325. REJECTED
  1326. # The merchant requested a cancellation of the fulfillment request for this fulfillment order.
  1327. CANCELLATION_REQUESTED
  1328. # The fulfillment service accepted the merchant's fulfillment cancellation request.
  1329. CANCELLATION_ACCEPTED
  1330. # The fulfillment service rejected the merchant's fulfillment cancellation request.
  1331. CANCELLATION_REJECTED
  1332. # The fulfillment service closed the fulfillment order without completing it.
  1333. CLOSED
  1334. }
  1335. # The status of a fulfillment order.
  1336. enum FulfillmentOrderStatus {
  1337. # The fulfillment order is ready for fulfillment.
  1338. OPEN
  1339. # The fulfillment order is being processed.
  1340. IN_PROGRESS
  1341. # The fulfillment order has been cancelled by the merchant.
  1342. CANCELLED
  1343. # The fulfillment order cannot be completed as requested.
  1344. INCOMPLETE
  1345. # The fulfillment order has been completed and closed.
  1346. CLOSED
  1347. # The fulfillment order is deferred and will be ready for fulfillment after the date and time specified in fulfill_at.
  1348. SCHEDULED
  1349. # The fulfillment order is on hold. The fulfillment process can't be initiated until the hold on the fulfillment order is released.
  1350. ON_HOLD
  1351. }
  1352. # The actions that can be taken on a fulfillment order.
  1353. enum FulfillmentOrderAction {
  1354. # Creates a fulfillment for selected line items in the fulfillment order.
  1355. # The corresponding mutation for this action is fulfillmentCreateV2.
  1356. CREATE_FULFILLMENT
  1357. # Sends a request for fulfilling selected line items in a fulfillment order to a fulfillment service.
  1358. # The corresponding mutation for this action is fulfillmentOrderSubmitFulfillmentRequest.
  1359. REQUEST_FULFILLMENT
  1360. # Cancels a fulfillment order.
  1361. # The corresponding mutation for this action is fulfillmentOrderCancel.
  1362. CANCEL_FULFILLMENT_ORDER
  1363. # Moves a fulfillment order.
  1364. # The corresponding mutation for this action is fulfillmentOrderMove.
  1365. MOVE
  1366. # Sends a cancellation request to the fulfillment service of a fulfillment order.
  1367. # The corresponding mutation for this action is fulfillmentOrderSubmitCancellationRequest.
  1368. REQUEST_CANCELLATION
  1369. # Marks the fulfillment order as open.
  1370. # The corresponding mutation for this action is fulfillmentOrderOpen.
  1371. MARK_AS_OPEN
  1372. # Releases the fulfillment hold on the fulfillment order.
  1373. # The corresponding mutation for this action is fulfillmentOrderReleaseHold.
  1374. RELEASE_HOLD
  1375. # Applies a fulfillment hold on an open fulfillment order.
  1376. # The corresponding mutation for this action is fulfillmentOrderHold.
  1377. HOLD
  1378. # Opens an external URL to initiate the fulfillment process outside Shopify.
  1379. # This action should be paired with FulfillmentOrderSupportedAction.externalUrl.
  1380. EXTERNAL
  1381. }
  1382. # The status that describes a fulfillment or delivery event.
  1383. enum FulfillmentEventStatus {
  1384. # A shipping label has been purchased.
  1385. LABEL_PURCHASED
  1386. # A purchased shipping label has been printed.
  1387. LABEL_PRINTED
  1388. # The fulfillment is ready to be picked up.
  1389. READY_FOR_PICKUP
  1390. # The fulfillment is confirmed. This is the default value when no other information is available.
  1391. CONFIRMED
  1392. # The fulfillment is in transit.
  1393. IN_TRANSIT
  1394. # The fulfillment is out for delivery.
  1395. OUT_FOR_DELIVERY
  1396. # A delivery was attempted.
  1397. ATTEMPTED_DELIVERY
  1398. # The fulfillment was successfully delivered.
  1399. DELIVERED
  1400. # The fulfillment request failed.
  1401. FAILURE
  1402. }
  1403. # Represents a percentage price adjustment type.
  1404. enum PriceListAdjustmentType {
  1405. # Percentage decrease type. Prices will have a lower value.
  1406. PERCENTAGE_DECREASE
  1407. # Percentage increase type. Prices will have a higher value.
  1408. PERCENTAGE_INCREASE
  1409. }
  1410. # Represents the origin of a price, either fixed (defined on the price list)
  1411. # or relative (calculated using a price list adjustment configuration).
  1412. enum PriceListPriceOriginType {
  1413. # The price is defined on the price list.
  1414. FIXED
  1415. # The price is relative to the adjustment type and value.
  1416. RELATIVE
  1417. }
  1418. # The set of valid sort keys for the Collection query.
  1419. enum CollectionSortKeys {
  1420. # Sort by the title value.
  1421. TITLE
  1422. # Sort by the updated_at value.
  1423. UPDATED_AT
  1424. # Sort by the id value.
  1425. ID
  1426. # Sort by relevance to the search terms when the query parameter is specified on the connection.
  1427. # Don't use this sort key when no search query is specified.
  1428. RELEVANCE
  1429. }
  1430. # The set of valid sort keys for the ProductImage query.
  1431. enum ProductImageSortKeys {
  1432. # Sort by the created_at value.
  1433. CREATED_AT
  1434. # Sort by the position value.
  1435. POSITION
  1436. # Sort by the id value.
  1437. ID
  1438. # Sort by relevance to the search terms when the query parameter is specified on the connection.
  1439. # Don't use this sort key when no search query is specified.
  1440. RELEVANCE
  1441. }
  1442. # The set of valid sort keys for the ProductMedia query.
  1443. enum ProductMediaSortKeys {
  1444. # Sort by the position value.
  1445. POSITION
  1446. # Sort by the id value.
  1447. ID
  1448. # Sort by relevance to the search terms when the query parameter is specified on the connection.
  1449. # Don't use this sort key when no search query is specified.
  1450. RELEVANCE
  1451. }
  1452. # The possible product statuses.
  1453. enum ProductStatus {
  1454. # The product is ready to sell and can be published to sales channels and apps.
  1455. # Products with an active status aren't automatically published to sales channels, such as the online store, or apps.
  1456. # By default, existing products are set to active.
  1457. ACTIVE
  1458. # The product is no longer being sold and isn't available to customers on sales channels and apps.
  1459. ARCHIVED
  1460. # The product isn't ready to sell and is unavailable to customers on sales channels and apps.
  1461. # By default, duplicated and unarchived products are set to draft.
  1462. DRAFT
  1463. }
  1464. # The set of valid sort keys for the ProductVariant query.
  1465. enum ProductVariantSortKeys {
  1466. # Sort by the title value.
  1467. TITLE
  1468. # Sort by the name value.
  1469. NAME
  1470. # Sort by the sku value.
  1471. SKU
  1472. # Sort by the inventory_quantity value.
  1473. INVENTORY_QUANTITY
  1474. # Sort by the inventory_management value.
  1475. INVENTORY_MANAGEMENT
  1476. # Sort by the inventory_levels.available value.
  1477. INVENTORY_LEVELS_AVAILABLE
  1478. # Sort by the inventory_policy value.
  1479. INVENTORY_POLICY
  1480. # Sort by the full_title value.
  1481. FULL_TITLE
  1482. # Sort by the popular value.
  1483. POPULAR
  1484. # Sort by the position value.
  1485. POSITION
  1486. # Sort by the id value.
  1487. ID
  1488. # Sort by relevance to the search terms when the query parameter is specified on the connection.
  1489. # Don't use this sort key when no search query is specified.
  1490. RELEVANCE
  1491. }
  1492. # The possible content types for a media object.
  1493. enum MediaContentType {
  1494. # A Shopify-hosted video.
  1495. VIDEO
  1496. # An externally hosted video.
  1497. EXTERNAL_VIDEO
  1498. # A 3d model.
  1499. MODEL_3D
  1500. # A Shopify-hosted image.
  1501. IMAGE
  1502. }
  1503. # Error types for media.
  1504. enum MediaErrorCode {
  1505. # Media error has occured for unknown reason.
  1506. UNKNOWN
  1507. # Media could not be processed because the signed URL was invalid.
  1508. INVALID_SIGNED_URL
  1509. # Media could not be processed because the image could not be downloaded.
  1510. IMAGE_DOWNLOAD_FAILURE
  1511. # Media could not be processed because the image could not be processed.
  1512. IMAGE_PROCESSING_FAILURE
  1513. # Media timed out because it is currently being modified by another operation.
  1514. MEDIA_TIMEOUT_ERROR
  1515. # Media could not be created because the external video could not be found.
  1516. EXTERNAL_VIDEO_NOT_FOUND
  1517. # Media could not be created because the external video is not listed or is private.
  1518. EXTERNAL_VIDEO_UNLISTED
  1519. # Media could not be created because the external video has an invalid aspect ratio.
  1520. EXTERNAL_VIDEO_INVALID_ASPECT_RATIO
  1521. # Media could not be created because embed permissions are disabled for this video.
  1522. EXTERNAL_VIDEO_EMBED_DISABLED
  1523. # Media could not be created because video is either not found or still transcoding.
  1524. EXTERNAL_VIDEO_EMBED_NOT_FOUND_OR_TRANSCODING
  1525. # File could not be processed because the source could not be downloaded.
  1526. GENERIC_FILE_DOWNLOAD_FAILURE
  1527. # File could not be created because the size is too large.
  1528. GENERIC_FILE_INVALID_SIZE
  1529. # Media could not be created because the metadata could not be read.
  1530. VIDEO_METADATA_READ_ERROR
  1531. # Media could not be created because it has an invalid file type.
  1532. VIDEO_INVALID_FILETYPE_ERROR
  1533. # Media could not be created because it does not meet the minimum width requirement.
  1534. VIDEO_MIN_WIDTH_ERROR
  1535. # Media could not be created because it does not meet the maximum width requirement.
  1536. VIDEO_MAX_WIDTH_ERROR
  1537. # Media could not be created because it does not meet the minimum height requirement.
  1538. VIDEO_MIN_HEIGHT_ERROR
  1539. # Media could not be created because it does not meet the maximum height requirement.
  1540. VIDEO_MAX_HEIGHT_ERROR
  1541. # Media could not be created because it does not meet the minimum duration requirement.
  1542. VIDEO_MIN_DURATION_ERROR
  1543. # Media could not be created because it does not meet the maximum duration requirement.
  1544. VIDEO_MAX_DURATION_ERROR
  1545. # Video failed validation.
  1546. VIDEO_VALIDATION_ERROR
  1547. # Model failed validation.
  1548. MODEL3D_VALIDATION_ERROR
  1549. # Media could not be created because the model's thumbnail generation failed.
  1550. MODEL3D_THUMBNAIL_GENERATION_ERROR
  1551. # Media could not be created because the model can't be converted to USDZ format.
  1552. MODEL3D_GLB_TO_USDZ_CONVERSION_ERROR
  1553. # Media could not be created because the model file failed processing.
  1554. MODEL3D_GLB_OUTPUT_CREATION_ERROR
  1555. # Media could not be created because the model file failed processing.
  1556. MODEL3D_PROCESSING_FAILURE
  1557. # Media could not be created because the image is an unsupported file type.
  1558. UNSUPPORTED_IMAGE_FILE_TYPE
  1559. # Media could not be created because the image size is too large.
  1560. INVALID_IMAGE_FILE_SIZE
  1561. # Media could not be created because the image has an invalid aspect ratio.
  1562. INVALID_IMAGE_ASPECT_RATIO
  1563. # Media could not be created because the image's resolution exceeds the max limit.
  1564. INVALID_IMAGE_RESOLUTION
  1565. # Media could not be created because the cumulative file storage limit would be exceeded.
  1566. FILE_STORAGE_LIMIT_EXCEEDED
  1567. }
  1568. # Warning types for media.
  1569. enum MediaWarningCode {
  1570. # 3D model physical size might be invalid.
  1571. # The dimensions of your model are very small.
  1572. # Consider reviewing your model to ensure they are correct.
  1573. MODEL_SMALL_PHYSICAL_SIZE
  1574. # 3D model physical size might be invalid.
  1575. # The dimensions of your model are very large.
  1576. # Consider reviewing your model to ensure they are correct.
  1577. MODEL_LARGE_PHYSICAL_SIZE
  1578. }
  1579. # The possible statuses for a media preview image.
  1580. enum MediaPreviewImageStatus {
  1581. # Preview image is uploaded but not yet processed.
  1582. UPLOADED
  1583. # Preview image is being processed.
  1584. PROCESSING
  1585. # Preview image is ready to be displayed.
  1586. READY
  1587. # Preview image processing has failed.
  1588. FAILED
  1589. }
  1590. # The possible statuses for a media object.
  1591. enum MediaStatus {
  1592. # Media has been uploaded but not yet processed.
  1593. UPLOADED
  1594. # Media is being processed.
  1595. PROCESSING
  1596. # Media is ready to be displayed.
  1597. READY
  1598. # Media processing has failed.
  1599. FAILED
  1600. }
  1601. # The error types for a file.
  1602. enum FileErrorCode {
  1603. # File error has occurred for an unknown reason.
  1604. UNKNOWN
  1605. # File could not be processed because the signed URL was invalid.
  1606. INVALID_SIGNED_URL
  1607. # File could not be processed because the image could not be downloaded.
  1608. IMAGE_DOWNLOAD_FAILURE
  1609. # File could not be processed because the image could not be processed.
  1610. IMAGE_PROCESSING_FAILURE
  1611. # File timed out because it is currently being modified by another operation.
  1612. MEDIA_TIMEOUT_ERROR
  1613. # File could not be created because the external video could not be found.
  1614. EXTERNAL_VIDEO_NOT_FOUND
  1615. # File could not be created because the external video is not listed or is private.
  1616. EXTERNAL_VIDEO_UNLISTED
  1617. # File could not be created because the external video has an invalid aspect ratio.
  1618. EXTERNAL_VIDEO_INVALID_ASPECT_RATIO
  1619. # File could not be created because embed permissions are disabled for this video.
  1620. EXTERNAL_VIDEO_EMBED_DISABLED
  1621. # File could not be created because video is either not found or still transcoding.
  1622. EXTERNAL_VIDEO_EMBED_NOT_FOUND_OR_TRANSCODING
  1623. # File could not be processed because the source could not be downloaded.
  1624. GENERIC_FILE_DOWNLOAD_FAILURE
  1625. # File could not be created because the size is too large.
  1626. GENERIC_FILE_INVALID_SIZE
  1627. # File could not be created because the metadata could not be read.
  1628. VIDEO_METADATA_READ_ERROR
  1629. # File could not be created because it has an invalid file type.
  1630. VIDEO_INVALID_FILETYPE_ERROR
  1631. # File could not be created because it does not meet the minimum width requirement.
  1632. VIDEO_MIN_WIDTH_ERROR
  1633. # File could not be created because it does not meet the maximum width requirement.
  1634. VIDEO_MAX_WIDTH_ERROR
  1635. # File could not be created because it does not meet the minimum height requirement.
  1636. VIDEO_MIN_HEIGHT_ERROR
  1637. # File could not be created because it does not meet the maximum height requirement.
  1638. VIDEO_MAX_HEIGHT_ERROR
  1639. # File could not be created because it does not meet the minimum duration requirement.
  1640. VIDEO_MIN_DURATION_ERROR
  1641. # File could not be created because it does not meet the maximum duration requirement.
  1642. VIDEO_MAX_DURATION_ERROR
  1643. # Video failed validation.
  1644. VIDEO_VALIDATION_ERROR
  1645. # Model failed validation.
  1646. MODEL3D_VALIDATION_ERROR
  1647. # File could not be created because the model's thumbnail generation failed.
  1648. MODEL3D_THUMBNAIL_GENERATION_ERROR
  1649. # File could not be created because the model can't be converted to USDZ format.
  1650. MODEL3D_GLB_TO_USDZ_CONVERSION_ERROR
  1651. # File could not be created because the model file failed processing.
  1652. MODEL3D_GLB_OUTPUT_CREATION_ERROR
  1653. # File could not be created because the model file failed processing.
  1654. MODEL3D_PROCESSING_FAILURE
  1655. # File could not be created because the image is an unsupported file type.
  1656. UNSUPPORTED_IMAGE_FILE_TYPE
  1657. # File could not be created because the image size is too large.
  1658. INVALID_IMAGE_FILE_SIZE
  1659. # File could not be created because the image has an invalid aspect ratio.
  1660. INVALID_IMAGE_ASPECT_RATIO
  1661. # File could not be created because the image's resolution exceeds the max limit.
  1662. INVALID_IMAGE_RESOLUTION
  1663. # File could not be created because the cumulative file storage limit would be exceeded.
  1664. FILE_STORAGE_LIMIT_EXCEEDED
  1665. }
  1666. # The possible statuses for a file object.
  1667. enum FileStatus {
  1668. # File has been uploaded but hasn't been processed.
  1669. UPLOADED
  1670. # File is being processed.
  1671. PROCESSING
  1672. # File is ready to be displayed.
  1673. READY
  1674. # File processing has failed.
  1675. FAILED
  1676. }
  1677. # When to capture the payment for the remaining amount due.
  1678. enum SellingPlanRemainingBalanceChargeTrigger {
  1679. # When there's no remaining balance to be charged after checkout.
  1680. NO_REMAINING_BALANCE
  1681. # At an exact time defined by the remaining_balance_charge_exact_time field.
  1682. EXACT_TIME
  1683. # After the duration defined by the remaining_balance_charge_time_after_checkout field.
  1684. TIME_AFTER_CHECKOUT
  1685. }
  1686. # The checkout charge when the full amount isn't charged at checkout.
  1687. enum SellingPlanCheckoutChargeType {
  1688. # The checkout charge is a percentage of the product or variant price.
  1689. PERCENTAGE
  1690. # The checkout charge is a fixed price amount.
  1691. PRICE
  1692. }
  1693. # Describes what triggers fulfillment.
  1694. enum SellingPlanFulfillmentTrigger {
  1695. # Use the anchor values to calculate fulfillment date.
  1696. ANCHOR
  1697. # As soon as possible.
  1698. ASAP
  1699. # At an exact time defined by the fulfillment_exact_time field.
  1700. EXACT_TIME
  1701. # Unknown. Usually to be determined in the future.
  1702. UNKNOWN
  1703. }
  1704. # Possible intentions of a Delivery Policy.
  1705. enum SellingPlanFixedDeliveryPolicyIntent {
  1706. # A merchant-centric delivery policy.
  1707. # Mark this delivery policy to define when the merchant should start fulfillment.
  1708. FULFILLMENT_BEGIN
  1709. }
  1710. # Whether the delivery policy is merchant or buyer-centric.
  1711. enum SellingPlanRecurringDeliveryPolicyIntent {
  1712. # A merchant-centric delivery policy.
  1713. # Mark this delivery policy to define when the merchant should start fulfillment.
  1714. FULFILLMENT_BEGIN
  1715. }
  1716. # The fulfillment or delivery behavior of the first fulfillment when the orderis placed before the anchor.
  1717. enum SellingPlanFixedDeliveryPolicyPreAnchorBehavior {
  1718. # Orders placed can be fulfilled / delivered immediately.
  1719. # Orders placed inside a cutoff can be fulfilled / delivered at the next anchor.
  1720. ASAP
  1721. # Orders placed can be fulfilled / delivered at the next anchor date.
  1722. # Orders placed inside a cutoff will skip the next anchor and can be fulfilled /
  1723. # delivered at the following anchor.
  1724. NEXT
  1725. }
  1726. # The fulfillment or delivery behaviors of the first fulfillment when the orderis placed before the anchor.
  1727. enum SellingPlanRecurringDeliveryPolicyPreAnchorBehavior {
  1728. # The orders placed can be fulfilled or delivered immediately.
  1729. # The orders placed inside a cutoff can be fulfilled or delivered at the next anchor.
  1730. ASAP
  1731. # The orders placed can be fulfilled or delivered at the next anchor date.
  1732. # The orders placed inside a cutoff will skip the next anchor and can be fulfilled or
  1733. # delivered at the following anchor.
  1734. NEXT
  1735. }
  1736. # The frequency at which the shop is billed for an app subscription.
  1737. enum AppPricingInterval {
  1738. # The app subscription bills the shop annually.
  1739. ANNUAL
  1740. # The app subscription bills the shop every 30 days.
  1741. EVERY_30_DAYS
  1742. }
  1743. # The set of valid sort keys for the Product query.
  1744. enum ProductSortKeys {
  1745. # Sort by the title value.
  1746. TITLE
  1747. # Sort by the product_type value.
  1748. PRODUCT_TYPE
  1749. # Sort by the vendor value.
  1750. VENDOR
  1751. # Sort by the inventory_total value.
  1752. INVENTORY_TOTAL
  1753. # Sort by the updated_at value.
  1754. UPDATED_AT
  1755. # Sort by the created_at value.
  1756. CREATED_AT
  1757. # Sort by the published_at value.
  1758. PUBLISHED_AT
  1759. # Sort by the id value.
  1760. ID
  1761. # Sort by relevance to the search terms when the query parameter is specified on the connection.
  1762. # Don't use this sort key when no search query is specified.
  1763. RELEVANCE
  1764. }
  1765. # Possible error codes that can be returned by ProductChangeStatusUserError.
  1766. enum ProductChangeStatusUserErrorCode {
  1767. # Product could not be found.
  1768. PRODUCT_NOT_FOUND
  1769. }
  1770. # The assigment status to be used to filter fulfillment orders.
  1771. enum FulfillmentOrderAssignmentStatus {
  1772. # Fulfillment orders for which the merchant has requested cancellation of
  1773. # the previously accepted fulfillment request.
  1774. CANCELLATION_REQUESTED
  1775. # Fulfillment orders for which the merchant has requested fulfillment.
  1776. FULFILLMENT_REQUESTED
  1777. # Fulfillment orders for which the merchant's fulfillment request has been accepted.
  1778. # Any number of fulfillments can be created on these fulfillment orders
  1779. # to completely fulfill the requested items.
  1780. FULFILLMENT_ACCEPTED
  1781. }
  1782. # The set of valid sort keys for the FulfillmentOrder query.
  1783. enum FulfillmentOrderSortKeys {
  1784. # Sort by the id value.
  1785. ID
  1786. # Sort by relevance to the search terms when the query parameter is specified on the connection.
  1787. # Don't use this sort key when no search query is specified.
  1788. RELEVANCE
  1789. }
  1790. # Represents the shop's customer account requirement preference.
  1791. enum ShopCustomerAccountsSetting {
  1792. REQUIRED
  1793. OPTIONAL
  1794. DISABLED
  1795. }
  1796. # Possible sort of tags.
  1797. enum ShopTagSort {
  1798. # Alphabetical sort.
  1799. ALPHABETICAL
  1800. # Popularity sort.
  1801. POPULAR
  1802. }
  1803. # Digital wallet, such as Apple Pay, which can be used for accelerated checkouts.
  1804. enum DigitalWallet {
  1805. # Apple Pay.
  1806. APPLE_PAY
  1807. # Android Pay.
  1808. ANDROID_PAY
  1809. # Google Pay.
  1810. GOOGLE_PAY
  1811. # Shopify Pay.
  1812. SHOPIFY_PAY
  1813. }
  1814. # Specifies the type of resources to be returned from a search.
  1815. enum SearchResultType {
  1816. CUSTOMER
  1817. DRAFT_ORDER
  1818. PRODUCT
  1819. COLLECTION
  1820. # A file.
  1821. FILE
  1822. ONLINE_STORE_PAGE
  1823. ONLINE_STORE_BLOG
  1824. ONLINE_STORE_ARTICLE
  1825. # A URL redirect.
  1826. URL_REDIRECT
  1827. PRICE_RULE
  1828. # A code discount redeem code.
  1829. DISCOUNT_REDEEM_CODE
  1830. ORDER
  1831. }
  1832. # Available shop policy types.
  1833. enum ShopPolicyType {
  1834. # The refund policy.
  1835. REFUND_POLICY
  1836. # The shipping policy.
  1837. SHIPPING_POLICY
  1838. # The privacy policy.
  1839. PRIVACY_POLICY
  1840. # The terms of service.
  1841. TERMS_OF_SERVICE
  1842. # The terms of sale.
  1843. TERMS_OF_SALE
  1844. # The legal notice.
  1845. LEGAL_NOTICE
  1846. # The purchase options cancellation policy.
  1847. SUBSCRIPTION_POLICY
  1848. }
  1849. # Possible branding of a shop.
  1850. # Branding can be used to define the look of a shop including its styling and logo in the Shopify Admin.
  1851. enum ShopBranding {
  1852. # Shop has Shopify Gold branding.
  1853. SHOPIFY_GOLD
  1854. # Shop has Shopify Plus branding.
  1855. SHOPIFY_PLUS
  1856. # Shop has Rogers branding.
  1857. ROGERS
  1858. # Shop has Shopify branding.
  1859. SHOPIFY
  1860. }
  1861. # Systems of weights and measures.
  1862. enum UnitSystem {
  1863. # Imperial system of weights and measures.
  1864. IMPERIAL_SYSTEM
  1865. # Metric system of weights and measures.
  1866. METRIC_SYSTEM
  1867. }
  1868. # Represents a valid PayPal Express subscriptions gateway status.
  1869. enum PaypalExpressSubscriptionsGatewayStatus {
  1870. # The status is enabled.
  1871. ENABLED
  1872. # The status is disabled.
  1873. DISABLED
  1874. # The status is pending.
  1875. PENDING
  1876. }
  1877. # Possible error codes that can be returned by MediaUserError.
  1878. enum MediaUserErrorCode {
  1879. # The input value is invalid.
  1880. INVALID
  1881. # The input value is blank.
  1882. BLANK
  1883. # Video validation failed.
  1884. VIDEO_VALIDATION_ERROR
  1885. # Model validation failed.
  1886. MODEL3D_VALIDATION_ERROR
  1887. # Video creation throttle was exceeded.
  1888. VIDEO_THROTTLE_EXCEEDED
  1889. # Model3d creation throttle was exceeded.
  1890. MODEL3D_THROTTLE_EXCEEDED
  1891. # Exceeded the limit of media per product.
  1892. PRODUCT_MEDIA_LIMIT_EXCEEDED
  1893. # Exceeded the limit of media per shop.
  1894. SHOP_MEDIA_LIMIT_EXCEEDED
  1895. # Product does not exist.
  1896. PRODUCT_DOES_NOT_EXIST
  1897. # Media does not exist.
  1898. MEDIA_DOES_NOT_EXIST
  1899. # Media does not exist on the given product.
  1900. MEDIA_DOES_NOT_EXIST_ON_PRODUCT
  1901. # Only one mediaId is allowed per variant-media input pair.
  1902. TOO_MANY_MEDIA_PER_INPUT_PAIR
  1903. # Exceeded the maximum number of 100 variant-media pairs per mutation call.
  1904. MAXIMUM_VARIANT_MEDIA_PAIRS_EXCEEDED
  1905. # Invalid media type.
  1906. INVALID_MEDIA_TYPE
  1907. # Variant specified in more than one pair.
  1908. PRODUCT_VARIANT_SPECIFIED_MULTIPLE_TIMES
  1909. # Variant does not exist on the given product.
  1910. PRODUCT_VARIANT_DOES_NOT_EXIST_ON_PRODUCT
  1911. # Non-ready media are not supported.
  1912. NON_READY_MEDIA
  1913. # Product variant already has attached media.
  1914. PRODUCT_VARIANT_ALREADY_HAS_MEDIA
  1915. # The specified media is not attached to the specified variant.
  1916. MEDIA_IS_NOT_ATTACHED_TO_VARIANT
  1917. # Media cannot be modified. It is currently being modified by another operation.
  1918. MEDIA_CANNOT_BE_MODIFIED
  1919. }
  1920. # Possible error codes that can be returned by SellingPlanGroupUserError.
  1921. enum SellingPlanGroupUserErrorCode {
  1922. # The input value is blank.
  1923. BLANK
  1924. # The input value should be equal to the value allowed.
  1925. EQUAL_TO
  1926. # The input value should be greater than the minimum allowed value.
  1927. GREATER_THAN
  1928. # The input value should be greater than or equal to the minimum value allowed.
  1929. GREATER_THAN_OR_EQUAL_TO
  1930. # The input value isn't included in the list.
  1931. INCLUSION
  1932. # The input value is invalid.
  1933. INVALID
  1934. # The input value should be less than the maximum value allowed.
  1935. LESS_THAN
  1936. # The input value should be less than or equal to the maximum value allowed.
  1937. LESS_THAN_OR_EQUAL_TO
  1938. # The input value is not a number.
  1939. NOT_A_NUMBER
  1940. # The record with the ID used as the input value couldn't be found.
  1941. NOT_FOUND
  1942. # The input value needs to be blank.
  1943. PRESENT
  1944. # The input value is already taken.
  1945. TAKEN
  1946. # The input value is too big.
  1947. TOO_BIG
  1948. # The input value is too long.
  1949. TOO_LONG
  1950. # The input value is too short.
  1951. TOO_SHORT
  1952. # The input value is the wrong length.
  1953. WRONG_LENGTH
  1954. # Exceeded the selling plan limit (31).
  1955. SELLING_PLAN_COUNT_UPPER_BOUND
  1956. # Must include at least one selling plan.
  1957. SELLING_PLAN_COUNT_LOWER_BOUND
  1958. # Selling plan's billing policy max cycles must be greater than min cycles.
  1959. SELLING_PLAN_MAX_CYCLES_MUST_BE_GREATER_THAN_MIN_CYCLES
  1960. # Selling plan's billing and delivery policies anchors must be equal.
  1961. SELLING_PLAN_BILLING_AND_DELIVERY_POLICY_ANCHORS_MUST_BE_EQUAL
  1962. # Selling plan's billing cycle must be a multiple of delivery cycle.
  1963. SELLING_PLAN_BILLING_CYCLE_MUST_BE_A_MULTIPLE_OF_DELIVERY_CYCLE
  1964. # Selling plan's pricing policies must contain one fixed pricing policy.
  1965. SELLING_PLAN_PRICING_POLICIES_MUST_CONTAIN_A_FIXED_PRICING_POLICY
  1966. # Cannot define option2 on this selling plan as there's no label on the parent selling plan group.
  1967. SELLING_PLAN_MISSING_OPTION2_LABEL_ON_PARENT_GROUP
  1968. # Cannot define option3 on this selling plan as there's no label on the parent selling plan group.
  1969. SELLING_PLAN_MISSING_OPTION3_LABEL_ON_PARENT_GROUP
  1970. # Selling plan's option2 is required because option2 exists.
  1971. SELLING_PLAN_OPTION2_REQUIRED_AS_DEFINED_ON_PARENT_GROUP
  1972. # Selling plan's option3 is required because option3 exists.
  1973. SELLING_PLAN_OPTION3_REQUIRED_AS_DEFINED_ON_PARENT_GROUP
  1974. # Selling plans can't have more than 2 pricing policies.
  1975. SELLING_PLAN_PRICING_POLICIES_LIMIT
  1976. # The selling plan list provided contains 1 or more invalid IDs.
  1977. RESOURCE_LIST_CONTAINS_INVALID_IDS
  1978. # Product variant does not exist.
  1979. PRODUCT_VARIANT_DOES_NOT_EXIST
  1980. # Product does not exist.
  1981. PRODUCT_DOES_NOT_EXIST
  1982. # Selling plan group does not exist.
  1983. GROUP_DOES_NOT_EXIST
  1984. # Selling plan group could not be deleted.
  1985. GROUP_COULD_NOT_BE_DELETED
  1986. # Could not add the resource to the selling plan group.
  1987. ERROR_ADDING_RESOURCE_TO_GROUP
  1988. # Missing delivery policy.
  1989. SELLING_PLAN_DELIVERY_POLICY_MISSING
  1990. # Missing billing policy.
  1991. SELLING_PLAN_BILLING_POLICY_MISSING
  1992. # Selling plan does not exist.
  1993. PLAN_DOES_NOT_EXIST
  1994. # Selling plan ID must be specified to update.
  1995. PLAN_ID_MUST_BE_SPECIFIED_TO_UPDATE
  1996. # Only one billing policy type can be defined.
  1997. ONLY_NEED_ONE_BILLING_POLICY_TYPE
  1998. # Only one delivery policy type can be defined.
  1999. ONLY_NEED_ONE_DELIVERY_POLICY_TYPE
  2000. # Only one pricing policy type can be defined.
  2001. ONLY_NEED_ONE_PRICING_POLICY_TYPE
  2002. # Billing and delivery policy types must be the same.
  2003. BILLING_AND_DELIVERY_POLICY_TYPES_MUST_BE_THE_SAME
  2004. # Only one pricing policy adjustment value type can be defined.
  2005. ONLY_NEED_ONE_PRICING_POLICY_VALUE
  2006. # Pricing policy's adjustment value and adjustment type must match.
  2007. PRICING_POLICY_ADJUSTMENT_VALUE_AND_TYPE_MUST_MATCH
  2008. # Cannot have multiple selling plans with the same name.
  2009. SELLING_PLAN_DUPLICATE_NAME
  2010. # Cannot have multiple selling plans with the same options.
  2011. SELLING_PLAN_DUPLICATE_OPTIONS
  2012. # A fixed selling plan can have at most one pricing policy.
  2013. SELLING_PLAN_FIXED_PRICING_POLICIES_LIMIT
  2014. # A fixed billing policy's remaining_balance_charge_exact_time can't be blank when the remaining_balance_charge_trigger is EXACT_TIME.
  2015. REMAINING_BALANCE_CHARGE_EXACT_TIME_REQUIRED
  2016. # A fixed billing policy's checkout charge value and type must match.
  2017. CHECKOUT_CHARGE_VALUE_AND_TYPE_MUST_MATCH
  2018. # A fixed billing policy's checkout charge can have at most one value.
  2019. ONLY_NEED_ONE_CHECKOUT_CHARGE_VALUE
  2020. # A fixed billing policy's remaining_balance_charge_exact_time must not be present when the remaining_balance_charge_trigger isn't EXACT_TIME.
  2021. REMAINING_BALANCE_CHARGE_EXACT_TIME_NOT_ALLOWED
  2022. # A fixed billing policy's remaining_balance_charge_time_after_checkout must be present and greater than zero when the remaining_balance_charge_trigger is TIME_AFTER_CHECKOUT.
  2023. REMAINING_BALANCE_CHARGE_TIME_AFTER_CHECKOUT_MUST_BE_GREATER_THAN_ZERO
  2024. # A fixed billing policy's remaining_balance_charge_trigger must be NO_REMAINING_BALANCE when the checkout_charge_type is PERCENTAGE and checkout_charge_value is 100.
  2025. REMAINING_BALANCE_CHARGE_TRIGGER_ON_FULL_CHECKOUT
  2026. # A fixed billing policy's remaining_balance_charge_trigger can't be NO_REMAINING_BALANCE when the checkout_charge_type is PERCENTAGE and checkout_charge_value is less than 100.
  2027. REMAINING_BALANCE_CHARGE_TRIGGER_NO_REMAINING_BALANCE_ON_PARTIAL_PERCENTAGE_CHECKOUT_CHARGE
  2028. # A fixed billing policy's remaining_balance_charge_trigger can't be NO_REMAINING_BALANCE when the checkout_charge_type is PRICE.
  2029. REMAINING_BALANCE_CHARGE_TRIGGER_NO_REMAINING_BALANCE_ON_PRICE_CHECKOUT_CHARGE
  2030. # A fixed billing policy's fulfillment_exact_time can't be blank when the fulfillment_trigger is EXACT_TIME.
  2031. FULFILLMENT_EXACT_TIME_REQUIRED
  2032. # A fixed billing policy's fulfillment_exact_time must not be present when the fulfillment_trigger isn't EXACT_TIME.
  2033. FULFILLMENT_EXACT_TIME_NOT_ALLOWED
  2034. # A fixed delivery policy's anchors must not be present when the fulfillment_trigger isn't ANCHOR.
  2035. SELLING_PLAN_ANCHORS_NOT_ALLOWED
  2036. # A fixed delivery policy's anchors must be present when the fulfillment_trigger is ANCHOR.
  2037. SELLING_PLAN_ANCHORS_REQUIRED
  2038. # A selling plan can't have both fixed and recurring billing policies.
  2039. ONLY_ONE_OF_FIXED_OR_RECURRING_BILLING
  2040. # A selling plan can't have both fixed and recurring delivery policies.
  2041. ONLY_ONE_OF_FIXED_OR_RECURRING_DELIVERY
  2042. }
  2043. # Possible error codes that can be returned by ProductVariantsBulkCreateUserError.
  2044. enum ProductVariantsBulkCreateUserErrorCode {
  2045. # Product does not exist.
  2046. PRODUCT_DOES_NOT_EXIST
  2047. # On create, this key cannot be used.
  2048. NO_KEY_ON_CREATE
  2049. # Variant already exists.
  2050. VARIANT_ALREADY_EXISTS
  2051. # Variant price must be greater than or equal to zero.
  2052. GREATER_THAN_OR_EQUAL_TO
  2053. # Variant options are not enough.
  2054. NEED_TO_ADD_OPTION_VALUES
  2055. # Variant options are more than the product options.
  2056. OPTION_VALUES_FOR_NUMBER_OF_UNKNOWN_OPTIONS
  2057. # Inventory locations cannot exceed the allowed resource limit or 10.
  2058. TOO_MANY_INVENTORY_LOCATIONS
  2059. # You reached the limit of available SKUs in your current plan.
  2060. SUBSCRIPTION_VIOLATION
  2061. # Variant options already exist. Please change the variant option(s).
  2062. VARIANT_ALREADY_EXISTS_CHANGE_OPTION_VALUE
  2063. # Quantity could not be set. The location was not found.
  2064. TRACKED_VARIANT_LOCATION_NOT_FOUND
  2065. # Input must be for this product.
  2066. MUST_BE_FOR_THIS_PRODUCT
  2067. # Input is not defined for this shop.
  2068. NOT_DEFINED_FOR_SHOP
  2069. # Invalid input detected.
  2070. INVALID
  2071. # Price cannot take a negative value.
  2072. NEGATIVE_PRICE_VALUE
  2073. }
  2074. # Possible error codes that can be returned by ProductVariantsBulkDeleteUserError.
  2075. enum ProductVariantsBulkDeleteUserErrorCode {
  2076. # Product does not exist.
  2077. PRODUCT_DOES_NOT_EXIST
  2078. # Cannot delete default variant.
  2079. CANNOT_DELETE_LAST_VARIANT
  2080. # The variant does not exist.
  2081. AT_LEAST_ONE_VARIANT_DOES_NOT_BELONG_TO_THE_PRODUCT
  2082. }
  2083. # Possible error codes that can be returned by ProductVariantsBulkReorderUserError.
  2084. enum ProductVariantsBulkReorderUserErrorCode {
  2085. # Product does not exist.
  2086. PRODUCT_DOES_NOT_EXIST
  2087. # Product variant does not exist.
  2088. MISSING_VARIANT
  2089. # Product variant position cannot be zero or negative number.
  2090. INVALID_POSITION
  2091. # Product variant IDs must be unique.
  2092. DUPLICATED_VARIANT_ID
  2093. }
  2094. # Possible error codes that can be returned by ProductVariantsBulkUpdateUserError.
  2095. enum ProductVariantsBulkUpdateUserErrorCode {
  2096. # Product does not exist.
  2097. PRODUCT_DOES_NOT_EXIST
  2098. # Product variant is missing ID attribute.
  2099. PRODUCT_VARIANT_ID_MISSING
  2100. # Product variant does not exist.
  2101. PRODUCT_VARIANT_DOES_NOT_EXIST
  2102. # Inventory quantities cannot be updated with variants API.
  2103. NO_INVENTORY_QUANTITIES_ON_VARIANTS_UPDATE
  2104. # The variant already exists.
  2105. VARIANT_ALREADY_EXISTS
  2106. # The price of the variant must be greater than or equal to zero.
  2107. GREATER_THAN_OR_EQUAL_TO
  2108. # Variant options are not enough.
  2109. NEED_TO_ADD_OPTION_VALUES
  2110. # Variant options are more than the product options.
  2111. OPTION_VALUES_FOR_NUMBER_OF_UNKNOWN_OPTIONS
  2112. # You reached the limit of available SKUs in your current plan.
  2113. SUBSCRIPTION_VIOLATION
  2114. # Inventory quantities cannot be provided during update.
  2115. NO_INVENTORY_QUANTITES_DURING_UPDATE
  2116. # Price cannot take a negative value.
  2117. NEGATIVE_PRICE_VALUE
  2118. }
  2119. # The state of the resource feedback.
  2120. enum ResourceFeedbackState {
  2121. # No action required from merchant.
  2122. ACCEPTED
  2123. # The merchant needs to resolve an issue with the resource.
  2124. REQUIRES_ACTION
  2125. }
  2126. # ISO 639-1 language codes supported by Shopify.
  2127. enum LanguageCode {
  2128. # Afrikaans
  2129. AF
  2130. # Akan
  2131. AK
  2132. # Amharic
  2133. AM
  2134. # Arabic
  2135. AR
  2136. # Assamese
  2137. AS
  2138. # Azerbaijani
  2139. AZ
  2140. # Belarusian
  2141. BE
  2142. # Bulgarian
  2143. BG
  2144. # Bambara
  2145. BM
  2146. # Bangla
  2147. BN
  2148. # Tibetan
  2149. BO
  2150. # Breton
  2151. BR
  2152. # Bosnian
  2153. BS
  2154. # Catalan
  2155. CA
  2156. # Chechen
  2157. CE
  2158. # Czech
  2159. CS
  2160. # Church Slavic
  2161. CU
  2162. # Welsh
  2163. CY
  2164. # Danish
  2165. DA
  2166. # German
  2167. DE
  2168. # Dzongkha
  2169. DZ
  2170. # Ewe
  2171. EE
  2172. # Greek
  2173. EL
  2174. # English
  2175. EN
  2176. # Esperanto
  2177. EO
  2178. # Spanish
  2179. ES
  2180. # Estonian
  2181. ET
  2182. # Basque
  2183. EU
  2184. # Persian
  2185. FA
  2186. # Fulah
  2187. FF
  2188. # Finnish
  2189. FI
  2190. # Faroese
  2191. FO
  2192. # French
  2193. FR
  2194. # Western Frisian
  2195. FY
  2196. # Irish
  2197. GA
  2198. # Scottish Gaelic
  2199. GD
  2200. # Galician
  2201. GL
  2202. # Gujarati
  2203. GU
  2204. # Manx
  2205. GV
  2206. # Hausa
  2207. HA
  2208. # Hebrew
  2209. HE
  2210. # Hindi
  2211. HI
  2212. # Croatian
  2213. HR
  2214. # Hungarian
  2215. HU
  2216. # Armenian
  2217. HY
  2218. # Interlingua
  2219. IA
  2220. # Indonesian
  2221. ID
  2222. # Igbo
  2223. IG
  2224. # Sichuan Yi
  2225. II
  2226. # Icelandic
  2227. IS
  2228. # Italian
  2229. IT
  2230. # Japanese
  2231. JA
  2232. # Javanese
  2233. JV
  2234. # Georgian.
  2235. KA
  2236. # Kikuyu.
  2237. KI
  2238. # Kazakh.
  2239. KK
  2240. # Kalaallisut.
  2241. KL
  2242. # Khmer.
  2243. KM
  2244. # Kannada.
  2245. KN
  2246. # Korean.
  2247. KO
  2248. # Kashmiri.
  2249. KS
  2250. # Kurdish.
  2251. KU
  2252. # Cornish.
  2253. KW
  2254. # Kyrgyz.
  2255. KY
  2256. # Luxembourgish.
  2257. LB
  2258. # Ganda.
  2259. LG
  2260. # Lingala.
  2261. LN
  2262. # Lao.
  2263. LO
  2264. # Lithuanian.
  2265. LT
  2266. # Luba-Katanga.
  2267. LU
  2268. # Latvian.
  2269. LV
  2270. # Malagasy.
  2271. MG
  2272. # Māori.
  2273. MI
  2274. # Macedonian.
  2275. MK
  2276. # Malayalam.
  2277. ML
  2278. # Mongolian.
  2279. MN
  2280. # Marathi.
  2281. MR
  2282. # Malay.
  2283. MS
  2284. # Maltese.
  2285. MT
  2286. # Burmese.
  2287. MY
  2288. # Norwegian (Bokmål).
  2289. NB
  2290. # North Ndebele.
  2291. ND
  2292. # Nepali.
  2293. NE
  2294. # Dutch.
  2295. NL
  2296. # Norwegian Nynorsk.
  2297. NN
  2298. # Norwegian.
  2299. NO
  2300. # Oromo.
  2301. OM
  2302. # Odia.
  2303. OR
  2304. # Ossetic.
  2305. OS
  2306. # Punjabi.
  2307. PA
  2308. # Polish.
  2309. PL
  2310. # Pashto.
  2311. PS
  2312. # Portuguese (Brazil).
  2313. PT_BR
  2314. # Portuguese (Portugal).
  2315. PT_PT
  2316. QU
  2317. # Quechua.
  2318. # Romansh.
  2319. RM
  2320. # Rundi.
  2321. RN
  2322. # Romanian.
  2323. RO
  2324. # Russian.
  2325. RU
  2326. # Kinyarwanda.
  2327. RW
  2328. # Sindhi.
  2329. SD
  2330. # Northern Sami.
  2331. SE
  2332. # Sango.
  2333. SG
  2334. # Sinhala.
  2335. SI
  2336. # Slovak.
  2337. SK
  2338. # Slovenian.
  2339. SL
  2340. # Shona.
  2341. SN
  2342. # Somali.
  2343. SO
  2344. # Albanian.
  2345. SQ
  2346. # Serbian.
  2347. SR
  2348. # Sundanese.
  2349. SU
  2350. # Swedish.
  2351. SV
  2352. # Swahili.
  2353. SW
  2354. # Tamil.
  2355. TA
  2356. # Telugu.
  2357. TE
  2358. # Tajik.
  2359. TG
  2360. # Thai.
  2361. TH
  2362. # Tigrinya.
  2363. TI
  2364. # Turkmen.
  2365. TK
  2366. # Tongan.
  2367. TO
  2368. # Turkish.
  2369. TR
  2370. # Tatar.
  2371. TT
  2372. # Uyghur.
  2373. UG
  2374. # Ukrainian.
  2375. UK
  2376. # Urdu.
  2377. UR
  2378. # Uzbek.
  2379. UZ
  2380. # Vietnamese.
  2381. VI
  2382. # Wolof.
  2383. WO
  2384. # Xhosa.
  2385. XH
  2386. # Yiddish.
  2387. YI
  2388. # Yoruba.
  2389. YO
  2390. # Chinese (Simplified).
  2391. ZH_CN
  2392. # Chinese (Traditional).
  2393. ZH_TW
  2394. # Zulu.
  2395. ZU
  2396. # Chinese.
  2397. ZH
  2398. # Portuguese.
  2399. PT
  2400. # Volapük.
  2401. VO
  2402. }
  2403. # The code designating a country/region, which generally follows ISO 3166-1 alpha-2 guidelines.
  2404. # If a territory doesn't have a country code value in the CountryCode enum, then it might be considered a subdivision
  2405. # of another country. For example, the territories associated with Spain are represented by the country code ES,
  2406. # and the territories associated with the United States of America are represented by the country code US.
  2407. enum CountryCode {
  2408. # Afghanistan.
  2409. AF
  2410. # Åland Islands.
  2411. AX
  2412. # Albania.
  2413. AL
  2414. # Algeria.
  2415. DZ
  2416. # Andorra.
  2417. AD
  2418. # Angola.
  2419. AO
  2420. # Anguilla.
  2421. AI
  2422. # Antigua & Barbuda.
  2423. AG
  2424. # Argentina.
  2425. AR
  2426. # Armenia.
  2427. AM
  2428. # Aruba.
  2429. AW
  2430. # Ascension Island.
  2431. AC
  2432. # Australia.
  2433. AU
  2434. # Austria.
  2435. AT
  2436. # Azerbaijan.
  2437. AZ
  2438. # Bahamas.
  2439. BS
  2440. # Bahrain.
  2441. BH
  2442. # Bangladesh.
  2443. BD
  2444. # Barbados.
  2445. BB
  2446. # Belarus.
  2447. BY
  2448. # Belgium.
  2449. BE
  2450. # Belize.
  2451. BZ
  2452. # Benin.
  2453. BJ
  2454. # Bermuda.
  2455. BM
  2456. # Bhutan.
  2457. BT
  2458. # Bolivia.
  2459. BO
  2460. # Bosnia & Herzegovina.
  2461. BA
  2462. # Botswana.
  2463. BW
  2464. # Bouvet Island.
  2465. BV
  2466. # Brazil.
  2467. BR
  2468. # British Indian Ocean Territory.
  2469. IO
  2470. # Brunei.
  2471. BN
  2472. # Bulgaria.
  2473. BG
  2474. # Burkina Faso.
  2475. BF
  2476. # Burundi.
  2477. BI
  2478. # Cambodia.
  2479. KH
  2480. # Canada.
  2481. CA
  2482. # Cape Verde.
  2483. CV
  2484. # Caribbean Netherlands.
  2485. BQ
  2486. # Cayman Islands.
  2487. KY
  2488. # Central African Republic.
  2489. CF
  2490. # Chad.
  2491. TD
  2492. # Chile.
  2493. CL
  2494. # China.
  2495. CN
  2496. # Christmas Island.
  2497. CX
  2498. # Cocos (Keeling) Islands.
  2499. CC
  2500. # Colombia.
  2501. CO
  2502. # Comoros.
  2503. KM
  2504. # Congo - Brazzaville.
  2505. CG
  2506. # Congo - Kinshasa.
  2507. CD
  2508. # Cook Islands.
  2509. CK
  2510. # Costa Rica.
  2511. CR
  2512. # Croatia.
  2513. HR
  2514. # Cuba.
  2515. CU
  2516. # Curaçao.
  2517. CW
  2518. # Cyprus.
  2519. CY
  2520. # Czechia.
  2521. CZ
  2522. # Côte d’Ivoire.
  2523. CI
  2524. # Denmark.
  2525. DK
  2526. # Djibouti.
  2527. DJ
  2528. # Dominica.
  2529. DM
  2530. # Dominican Republic.
  2531. DO
  2532. # Ecuador.
  2533. EC
  2534. # Egypt.
  2535. EG
  2536. # El Salvador.
  2537. SV
  2538. # Equatorial Guinea.
  2539. GQ
  2540. # Eritrea.
  2541. ER
  2542. # Estonia.
  2543. EE
  2544. # Eswatini.
  2545. SZ
  2546. # Ethiopia.
  2547. ET
  2548. # Falkland Islands.
  2549. FK
  2550. # Faroe Islands.
  2551. FO
  2552. # Fiji.
  2553. FJ
  2554. # Finland.
  2555. FI
  2556. # France.
  2557. FR
  2558. # French Guiana.
  2559. GF
  2560. # French Polynesia.
  2561. PF
  2562. # French Southern Territories.
  2563. TF
  2564. # Gabon.
  2565. GA
  2566. # Gambia.
  2567. GM
  2568. # Georgia.
  2569. GE
  2570. # Germany.
  2571. DE
  2572. # Ghana.
  2573. GH
  2574. # Gibraltar.
  2575. GI
  2576. # Greece.
  2577. GR
  2578. # Greenland.
  2579. GL
  2580. # Grenada.
  2581. GD
  2582. # Guadeloupe.
  2583. GP
  2584. # Guatemala.
  2585. GT
  2586. # Guernsey.
  2587. GG
  2588. # Guinea.
  2589. GN
  2590. # Guinea-Bissau.
  2591. GW
  2592. # Guyana.
  2593. GY
  2594. # Haiti.
  2595. HT
  2596. # Heard & McDonald Islands.
  2597. HM
  2598. # Vatican City.
  2599. VA
  2600. # Honduras.
  2601. HN
  2602. # Hong Kong SAR.
  2603. HK
  2604. # Hungary.
  2605. HU
  2606. # Iceland.
  2607. IS
  2608. # India.
  2609. IN
  2610. # Indonesia.
  2611. ID
  2612. # Iran.
  2613. IR
  2614. # Iraq.
  2615. IQ
  2616. # Ireland.
  2617. IE
  2618. # Isle of Man.
  2619. IM
  2620. # Israel.
  2621. IL
  2622. # Italy.
  2623. IT
  2624. # Jamaica.
  2625. JM
  2626. # Japan.
  2627. JP
  2628. # Jersey.
  2629. JE
  2630. # Jordan.
  2631. JO
  2632. # Kazakhstan.
  2633. KZ
  2634. # Kenya.
  2635. KE
  2636. # Kiribati.
  2637. KI
  2638. # North Korea.
  2639. KP
  2640. # Kosovo.
  2641. XK
  2642. # Kuwait.
  2643. KW
  2644. # Kyrgyzstan.
  2645. KG
  2646. # Laos.
  2647. LA
  2648. # Latvia.
  2649. LV
  2650. # Lebanon.
  2651. LB
  2652. # Lesotho.
  2653. LS
  2654. # Liberia.
  2655. LR
  2656. # Libya.
  2657. LY
  2658. # Liechtenstein.
  2659. LI
  2660. # Lithuania.
  2661. LT
  2662. # Luxembourg.
  2663. LU
  2664. # Macao SAR.
  2665. MO
  2666. # Madagascar.
  2667. MG
  2668. # Malawi.
  2669. MW
  2670. # Malaysia.
  2671. MY
  2672. # Maldives.
  2673. MV
  2674. # Mali.
  2675. ML
  2676. # Malta.
  2677. MT
  2678. # Martinique.
  2679. MQ
  2680. # Mauritania.
  2681. MR
  2682. # Mauritius.
  2683. MU
  2684. # Mayotte.
  2685. YT
  2686. # Mexico.
  2687. MX
  2688. # Moldova.
  2689. MD
  2690. # Monaco.
  2691. MC
  2692. # Mongolia.
  2693. MN
  2694. # Montenegro.
  2695. ME
  2696. # Montserrat.
  2697. MS
  2698. # Morocco.
  2699. MA
  2700. # Mozambique.
  2701. MZ
  2702. # Myanmar (Burma).
  2703. MM
  2704. # Namibia.
  2705. NA
  2706. # Nauru.
  2707. NR
  2708. # Nepal.
  2709. NP
  2710. # Netherlands.
  2711. NL
  2712. # Netherlands Antilles.
  2713. AN
  2714. # New Caledonia.
  2715. NC
  2716. # New Zealand.
  2717. NZ
  2718. # Nicaragua.
  2719. NI
  2720. # Niger.
  2721. NE
  2722. # Nigeria.
  2723. NG
  2724. # Niue.
  2725. NU
  2726. # Norfolk Island.
  2727. NF
  2728. # North Macedonia.
  2729. MK
  2730. # Norway.
  2731. NO
  2732. # Oman.
  2733. OM
  2734. # Pakistan.
  2735. PK
  2736. # Palestinian Territories.
  2737. PS
  2738. # Panama.
  2739. PA
  2740. # Papua New Guinea.
  2741. PG
  2742. # Paraguay.
  2743. PY
  2744. # Peru.
  2745. PE
  2746. # Philippines.
  2747. PH
  2748. # Pitcairn Islands.
  2749. PN
  2750. # Poland.
  2751. PL
  2752. # Portugal.
  2753. PT
  2754. # Qatar.
  2755. QA
  2756. # Cameroon.
  2757. CM
  2758. # Réunion.
  2759. RE
  2760. # Romania.
  2761. RO
  2762. # Russia.
  2763. RU
  2764. # Rwanda.
  2765. RW
  2766. # St. Barthélemy.
  2767. BL
  2768. # St. Helena.
  2769. SH
  2770. # St. Kitts & Nevis.
  2771. KN
  2772. # St. Lucia.
  2773. LC
  2774. # St. Martin.
  2775. MF
  2776. # St. Pierre & Miquelon.
  2777. PM
  2778. # Samoa.
  2779. WS
  2780. # San Marino.
  2781. SM
  2782. # São Tomé & Príncipe.
  2783. ST
  2784. # Saudi Arabia.
  2785. SA
  2786. # Senegal.
  2787. SN
  2788. # Serbia.
  2789. RS
  2790. # Seychelles.
  2791. SC
  2792. # Sierra Leone.
  2793. SL
  2794. # Singapore.
  2795. SG
  2796. # Sint Maarten.
  2797. SX
  2798. # Slovakia.
  2799. SK
  2800. # Slovenia.
  2801. SI
  2802. # Solomon Islands.
  2803. SB
  2804. # Somalia.
  2805. SO
  2806. # South Africa.
  2807. ZA
  2808. # South Georgia & South Sandwich Islands.
  2809. GS
  2810. # South Korea.
  2811. KR
  2812. # South Sudan.
  2813. SS
  2814. # Spain.
  2815. ES
  2816. # Sri Lanka.
  2817. LK
  2818. # St. Vincent & Grenadines.
  2819. VC
  2820. # Sudan.
  2821. SD
  2822. # Suriname.
  2823. SR
  2824. # Svalbard & Jan Mayen.
  2825. SJ
  2826. # Sweden.
  2827. SE
  2828. # Switzerland.
  2829. CH
  2830. # Syria.
  2831. SY
  2832. # Taiwan.
  2833. TW
  2834. # Tajikistan.
  2835. TJ
  2836. # Tanzania.
  2837. TZ
  2838. # Thailand.
  2839. TH
  2840. # Timor-Leste.
  2841. TL
  2842. # Togo.
  2843. TG
  2844. # Tokelau.
  2845. TK
  2846. # Tonga.
  2847. TO
  2848. # Trinidad & Tobago.
  2849. TT
  2850. # Tristan da Cunha.
  2851. TA
  2852. # Tunisia.
  2853. TN
  2854. # Turkey.
  2855. TR
  2856. # Turkmenistan.
  2857. TM
  2858. # Turks & Caicos Islands.
  2859. TC
  2860. # Tuvalu.
  2861. TV
  2862. # Uganda.
  2863. UG
  2864. # Ukraine.
  2865. UA
  2866. # United Arab Emirates.
  2867. AE
  2868. # United Kingdom.
  2869. GB
  2870. # United States.
  2871. US
  2872. # U.S. Outlying Islands.
  2873. UM
  2874. # Uruguay.
  2875. UY
  2876. # Uzbekistan.
  2877. UZ
  2878. # Vanuatu.
  2879. VU
  2880. # Venezuela.
  2881. VE
  2882. # Vietnam.
  2883. VN
  2884. # British Virgin Islands.
  2885. VG
  2886. # Wallis & Futuna.
  2887. WF
  2888. # Western Sahara.
  2889. EH
  2890. # Yemen.
  2891. YE
  2892. # Zambia.
  2893. ZM
  2894. # Zimbabwe.
  2895. ZW
  2896. # Unknown Region.
  2897. ZZ
  2898. }
  2899. # The three-letter currency codes that represent the world currencies used in stores. These include standard ISO 4217 codes, legacy codes, and non-standard codes.
  2900. enum CurrencyCode {
  2901. # United Arab Emirates Dirham (AED).
  2902. AED
  2903. # Afghan Afghani (AFN).
  2904. AFN
  2905. # Albanian Lek (ALL).
  2906. ALL
  2907. # Armenian Dram (AMD).
  2908. AMD
  2909. # Netherlands Antillean Guilder.
  2910. ANG
  2911. # Angolan Kwanza (AOA).
  2912. AOA
  2913. # Argentine Pesos (ARS).
  2914. ARS
  2915. # Australian Dollars (AUD).
  2916. AUD
  2917. # Aruban Florin (AWG).
  2918. AWG
  2919. # Azerbaijani Manat (AZN).
  2920. AZN
  2921. # Bosnia and Herzegovina Convertible Mark (BAM).
  2922. BAM
  2923. # Barbadian Dollar (BBD).
  2924. BBD
  2925. # Bangladesh Taka (BDT).
  2926. BDT
  2927. # Bulgarian Lev (BGN).
  2928. BGN
  2929. # Bahraini Dinar (BHD).
  2930. BHD
  2931. # Burundian Franc (BIF).
  2932. BIF
  2933. # Bermudian Dollar (BMD).
  2934. BMD
  2935. # Brunei Dollar (BND).
  2936. BND
  2937. # Bolivian Boliviano (BOB).
  2938. BOB
  2939. # Brazilian Real (BRL).
  2940. BRL
  2941. # Bahamian Dollar (BSD).
  2942. BSD
  2943. # Bhutanese Ngultrum (BTN).
  2944. BTN
  2945. # Botswana Pula (BWP).
  2946. BWP
  2947. # Belarusian Ruble (BYN).
  2948. BYN
  2949. # Belize Dollar (BZD).
  2950. BZD
  2951. # Canadian Dollars (CAD).
  2952. CAD
  2953. # Congolese franc (CDF).
  2954. CDF
  2955. # Swiss Francs (CHF).
  2956. CHF
  2957. # Chilean Peso (CLP).
  2958. CLP
  2959. # Chinese Yuan Renminbi (CNY).
  2960. CNY
  2961. # Colombian Peso (COP).
  2962. COP
  2963. # Costa Rican Colones (CRC).
  2964. CRC
  2965. # Cape Verdean escudo (CVE).
  2966. CVE
  2967. # Czech Koruny (CZK).
  2968. CZK
  2969. # Djiboutian Franc (DJF).
  2970. DJF
  2971. # Danish Kroner (DKK).
  2972. DKK
  2973. # Dominican Peso (DOP).
  2974. DOP
  2975. # Algerian Dinar (DZD).
  2976. DZD
  2977. # Egyptian Pound (EGP).
  2978. EGP
  2979. # Eritrean Nakfa (ERN).
  2980. ERN
  2981. # Ethiopian Birr (ETB).
  2982. ETB
  2983. # Euro (EUR).
  2984. EUR
  2985. # Fijian Dollars (FJD).
  2986. FJD
  2987. # Falkland Islands Pounds (FKP).
  2988. FKP
  2989. # United Kingdom Pounds (GBP).
  2990. GBP
  2991. # Georgian Lari (GEL).
  2992. GEL
  2993. # Ghanaian Cedi (GHS).
  2994. GHS
  2995. # Gibraltar Pounds (GIP).
  2996. GIP
  2997. # Gambian Dalasi (GMD).
  2998. GMD
  2999. # Guinean Franc (GNF).
  3000. GNF
  3001. # Guatemalan Quetzal (GTQ).
  3002. GTQ
  3003. # Guyanese Dollar (GYD).
  3004. GYD
  3005. # Hong Kong Dollars (HKD).
  3006. HKD
  3007. # Honduran Lempira (HNL).
  3008. HNL
  3009. # Croatian Kuna (HRK).
  3010. HRK
  3011. # Haitian Gourde (HTG).
  3012. HTG
  3013. # Hungarian Forint (HUF).
  3014. HUF
  3015. # Indonesian Rupiah (IDR).
  3016. IDR
  3017. # Israeli New Shekel (NIS).
  3018. ILS
  3019. # Indian Rupees (INR).
  3020. INR
  3021. # Iraqi Dinar (IQD).
  3022. IQD
  3023. # Iranian Rial (IRR).
  3024. IRR
  3025. # Icelandic Kronur (ISK).
  3026. ISK
  3027. # Jersey Pound.
  3028. JEP
  3029. # Jamaican Dollars (JMD).
  3030. JMD
  3031. # Jordanian Dinar (JOD).
  3032. JOD
  3033. # Japanese Yen (JPY).
  3034. JPY
  3035. # Kenyan Shilling (KES).
  3036. KES
  3037. # Kyrgyzstani Som (KGS).
  3038. KGS
  3039. # Cambodian Riel.
  3040. KHR
  3041. # Kiribati Dollar (KID).
  3042. KID
  3043. # Comorian Franc (KMF).
  3044. KMF
  3045. # South Korean Won (KRW).
  3046. KRW
  3047. # Kuwaiti Dinar (KWD).
  3048. KWD
  3049. # Cayman Dollars (KYD).
  3050. KYD
  3051. # Kazakhstani Tenge (KZT).
  3052. KZT
  3053. # Laotian Kip (LAK).
  3054. LAK
  3055. # Lebanese Pounds (LBP).
  3056. LBP
  3057. # Sri Lankan Rupees (LKR).
  3058. LKR
  3059. # Liberian Dollar (LRD).
  3060. LRD
  3061. # Lesotho Loti (LSL).
  3062. LSL
  3063. # Lithuanian Litai (LTL).
  3064. LTL
  3065. # Latvian Lati (LVL).
  3066. LVL
  3067. # Libyan Dinar (LYD).
  3068. LYD
  3069. # Moroccan Dirham.
  3070. MAD
  3071. # Moldovan Leu (MDL).
  3072. MDL
  3073. # Malagasy Ariary (MGA).
  3074. MGA
  3075. # Macedonia Denar (MKD).
  3076. MKD
  3077. # Burmese Kyat (MMK).
  3078. MMK
  3079. # Mongolian Tugrik.
  3080. MNT
  3081. # Macanese Pataca (MOP).
  3082. MOP
  3083. # Mauritanian Ouguiya (MRU).
  3084. MRU
  3085. # Mauritian Rupee (MUR).
  3086. MUR
  3087. # Maldivian Rufiyaa (MVR).
  3088. MVR
  3089. # Malawian Kwacha (MWK).
  3090. MWK
  3091. # Mexican Pesos (MXN).
  3092. MXN
  3093. # Malaysian Ringgits (MYR).
  3094. MYR
  3095. # Mozambican Metical.
  3096. MZN
  3097. # Namibian Dollar.
  3098. NAD
  3099. # Nigerian Naira (NGN).
  3100. NGN
  3101. # Nicaraguan Córdoba (NIO).
  3102. NIO
  3103. # Norwegian Kroner (NOK).
  3104. NOK
  3105. # Nepalese Rupee (NPR).
  3106. NPR
  3107. # New Zealand Dollars (NZD).
  3108. NZD
  3109. # Omani Rial (OMR).
  3110. OMR
  3111. # Panamian Balboa (PAB).
  3112. PAB
  3113. # Peruvian Nuevo Sol (PEN).
  3114. PEN
  3115. # Papua New Guinean Kina (PGK).
  3116. PGK
  3117. # Philippine Peso (PHP).
  3118. PHP
  3119. # Pakistani Rupee (PKR).
  3120. PKR
  3121. # Polish Zlotych (PLN).
  3122. PLN
  3123. # Paraguayan Guarani (PYG).
  3124. PYG
  3125. # Qatari Rial (QAR).
  3126. QAR
  3127. # Romanian Lei (RON).
  3128. RON
  3129. # Serbian dinar (RSD).
  3130. RSD
  3131. # Russian Rubles (RUB).
  3132. RUB
  3133. # Rwandan Franc (RWF).
  3134. RWF
  3135. # Saudi Riyal (SAR).
  3136. SAR
  3137. # Solomon Islands Dollar (SBD).
  3138. SBD
  3139. # Seychellois Rupee (SCR).
  3140. SCR
  3141. # Sudanese Pound (SDG).
  3142. SDG
  3143. # Swedish Kronor (SEK).
  3144. SEK
  3145. # Singapore Dollars (SGD).
  3146. SGD
  3147. # Saint Helena Pounds (SHP).
  3148. SHP
  3149. # Sierra Leonean Leone (SLL).
  3150. SLL
  3151. # Somali Shilling (SOS).
  3152. SOS
  3153. # Surinamese Dollar (SRD).
  3154. SRD
  3155. # South Sudanese Pound (SSP).
  3156. SSP
  3157. # Sao Tome And Principe Dobra (STN).
  3158. STN
  3159. # Syrian Pound (SYP).
  3160. SYP
  3161. # Swazi Lilangeni (SZL).
  3162. SZL
  3163. # Thai baht (THB).
  3164. THB
  3165. # Tajikistani Somoni (TJS).
  3166. TJS
  3167. # Turkmenistani Manat (TMT).
  3168. TMT
  3169. # Tunisian Dinar (TND).
  3170. TND
  3171. # Tongan Pa'anga (TOP).
  3172. TOP
  3173. # Turkish Lira (TRY).
  3174. TRY
  3175. # Trinidad and Tobago Dollars (TTD).
  3176. TTD
  3177. # Taiwan Dollars (TWD).
  3178. TWD
  3179. # Tanzanian Shilling (TZS).
  3180. TZS
  3181. # Ukrainian Hryvnia (UAH).
  3182. UAH
  3183. # Ugandan Shilling (UGX).
  3184. UGX
  3185. # United States Dollars (USD).
  3186. USD
  3187. # Uruguayan Pesos (UYU).
  3188. UYU
  3189. # Uzbekistan som (UZS).
  3190. UZS
  3191. # Venezuelan Bolivares (VED).
  3192. VED
  3193. # Venezuelan Bolivares (VES).
  3194. VES
  3195. # Vietnamese đồng (VND).
  3196. VND
  3197. # Vanuatu Vatu (VUV).
  3198. VUV
  3199. # Samoan Tala (WST).
  3200. WST
  3201. # Central African CFA Franc (XAF).
  3202. XAF
  3203. # East Caribbean Dollar (XCD).
  3204. XCD
  3205. # West African CFA franc (XOF).
  3206. XOF
  3207. # CFP Franc (XPF).
  3208. XPF
  3209. # Unrecognized currency.
  3210. XXX
  3211. # Yemeni Rial (YER).
  3212. YER
  3213. # South African Rand (ZAR).
  3214. ZAR
  3215. # Zambian Kwacha (ZMW).
  3216. ZMW
  3217. # Belarusian Ruble (BYR).
  3218. BYR @deprecated
  3219. }
  3220. # Units of measurement for weight.
  3221. enum WeightUnit {
  3222. # 1 kilogram equals 1000 grams.
  3223. KILOGRAMS
  3224. # Metric system unit of mass.
  3225. GRAMS
  3226. # 1 pound equals 16 ounces.
  3227. POUNDS
  3228. # Imperial system unit of mass.
  3229. OUNCES
  3230. }