Enums
AdjustmentType
- PROMOTION
- DISTRIBUTED_ORDER_PROMOTION
AssetType
- IMAGE
- VIDEO
- BINARY
CurrencyCode
ISO 4217 currency code
- // United Arab Emirates dirham
- AED
- // Afghan afghani
- AFN
- // Albanian lek
- ALL
- // Armenian dram
- AMD
- // Netherlands Antillean guilder
- ANG
- // Angolan kwanza
- AOA
- // Argentine peso
- ARS
- // Australian dollar
- AUD
- // Aruban florin
- AWG
- // Azerbaijani manat
- AZN
- // Bosnia and Herzegovina convertible mark
- BAM
- // Barbados dollar
- BBD
- // Bangladeshi taka
- BDT
- // Bulgarian lev
- BGN
- // Bahraini dinar
- BHD
- // Burundian franc
- BIF
- // Bermudian dollar
- BMD
- // Brunei dollar
- BND
- // Boliviano
- BOB
- // Brazilian real
- BRL
- // Bahamian dollar
- BSD
- // Bhutanese ngultrum
- BTN
- // Botswana pula
- BWP
- // Belarusian ruble
- BYN
- // Belize dollar
- BZD
- // Canadian dollar
- CAD
- // Congolese franc
- CDF
- // Swiss franc
- CHF
- // Chilean peso
- CLP
- // Renminbi (Chinese) yuan
- CNY
- // Colombian peso
- COP
- // Costa Rican colon
- CRC
- // Cuban convertible peso
- CUC
- // Cuban peso
- CUP
- // Cape Verde escudo
- CVE
- // Czech koruna
- CZK
- // Djiboutian franc
- DJF
- // Danish krone
- DKK
- // Dominican peso
- DOP
- // Algerian dinar
- DZD
- // Egyptian pound
- EGP
- // Eritrean nakfa
- ERN
- // Ethiopian birr
- ETB
- // Euro
- EUR
- // Fiji dollar
- FJD
- // Falkland Islands pound
- FKP
- // Pound sterling
- GBP
- // Georgian lari
- GEL
- // Ghanaian cedi
- GHS
- // Gibraltar pound
- GIP
- // Gambian dalasi
- GMD
- // Guinean franc
- GNF
- // Guatemalan quetzal
- GTQ
- // Guyanese dollar
- GYD
- // Hong Kong dollar
- HKD
- // Honduran lempira
- HNL
- // Croatian kuna
- HRK
- // Haitian gourde
- HTG
- // Hungarian forint
- HUF
- // Indonesian rupiah
- IDR
- // Israeli new shekel
- ILS
- // Indian rupee
- INR
- // Iraqi dinar
- IQD
- // Iranian rial
- IRR
- // Icelandic króna
- ISK
- // Jamaican dollar
- JMD
- // Jordanian dinar
- JOD
- // Japanese yen
- JPY
- // Kenyan shilling
- KES
- // Kyrgyzstani som
- KGS
- // Cambodian riel
- KHR
- // Comoro franc
- KMF
- // North Korean won
- KPW
- // South Korean won
- KRW
- // Kuwaiti dinar
- KWD
- // Cayman Islands dollar
- KYD
- // Kazakhstani tenge
- KZT
- // Lao kip
- LAK
- // Lebanese pound
- LBP
- // Sri Lankan rupee
- LKR
- // Liberian dollar
- LRD
- // Lesotho loti
- LSL
- // Libyan dinar
- LYD
- // Moroccan dirham
- MAD
- // Moldovan leu
- MDL
- // Malagasy ariary
- MGA
- // Macedonian denar
- MKD
- // Myanmar kyat
- MMK
- // Mongolian tögrög
- MNT
- // Macanese pataca
- MOP
- // Mauritanian ouguiya
- MRU
- // Mauritian rupee
- MUR
- // Maldivian rufiyaa
- MVR
- // Malawian kwacha
- MWK
- // Mexican peso
- MXN
- // Malaysian ringgit
- MYR
- // Mozambican metical
- MZN
- // Namibian dollar
- NAD
- // Nigerian naira
- NGN
- // Nicaraguan córdoba
- NIO
- // Norwegian krone
- NOK
- // Nepalese rupee
- NPR
- // New Zealand dollar
- NZD
- // Omani rial
- OMR
- // Panamanian balboa
- PAB
- // Peruvian sol
- PEN
- // Papua New Guinean kina
- PGK
- // Philippine peso
- PHP
- // Pakistani rupee
- PKR
- // Polish złoty
- PLN
- // Paraguayan guaraní
- PYG
- // Qatari riyal
- QAR
- // Romanian leu
- RON
- // Serbian dinar
- RSD
- // Russian ruble
- RUB
- // Rwandan franc
- RWF
- // Saudi riyal
- SAR
- // Solomon Islands dollar
- SBD
- // Seychelles rupee
- SCR
- // Sudanese pound
- SDG
- // Swedish krona/kronor
- SEK
- // Singapore dollar
- SGD
- // Saint Helena pound
- SHP
- // Sierra Leonean leone
- SLL
- // Somali shilling
- SOS
- // Surinamese dollar
- SRD
- // South Sudanese pound
- SSP
- // São Tomé and Príncipe dobra
- STN
- // Salvadoran colón
- SVC
- // Syrian pound
- SYP
- // Swazi lilangeni
- SZL
- // Thai baht
- THB
- // Tajikistani somoni
- TJS
- // Turkmenistan manat
- TMT
- // Tunisian dinar
- TND
- // Tongan paʻanga
- TOP
- // Turkish lira
- TRY
- // Trinidad and Tobago dollar
- TTD
- // New Taiwan dollar
- TWD
- // Tanzanian shilling
- TZS
- // Ukrainian hryvnia
- UAH
- // Ugandan shilling
- UGX
- // United States dollar
- USD
- // Uruguayan peso
- UYU
- // Uzbekistan som
- UZS
- // Venezuelan bolívar soberano
- VES
- // Vietnamese đồng
- VND
- // Vanuatu vatu
- VUV
- // Samoan tala
- WST
- // CFA franc BEAC
- XAF
- // East Caribbean dollar
- XCD
- // CFA franc BCEAO
- XOF
- // CFP franc (franc Pacifique)
- XPF
- // Yemeni rial
- YER
- // South African rand
- ZAR
- // Zambian kwacha
- ZMW
- // Zimbabwean dollar
- ZWL
DeletionResult
- // The entity was successfully deleted
- DELETED
- // Deletion did not take place, reason given in message
- NOT_DELETED
ErrorCode
- UNKNOWN_ERROR
- NATIVE_AUTH_STRATEGY_ERROR
- INVALID_CREDENTIALS_ERROR
- ORDER_STATE_TRANSITION_ERROR
- EMAIL_ADDRESS_CONFLICT_ERROR
- ORDER_LIMIT_ERROR
- NEGATIVE_QUANTITY_ERROR
- INSUFFICIENT_STOCK_ERROR
- ORDER_MODIFICATION_ERROR
- INELIGIBLE_SHIPPING_METHOD_ERROR
- ORDER_PAYMENT_STATE_ERROR
- PAYMENT_FAILED_ERROR
- PAYMENT_DECLINED_ERROR
- COUPON_CODE_INVALID_ERROR
- COUPON_CODE_EXPIRED_ERROR
- COUPON_CODE_LIMIT_ERROR
- ALREADY_LOGGED_IN_ERROR
- MISSING_PASSWORD_ERROR
- PASSWORD_ALREADY_SET_ERROR
- VERIFICATION_TOKEN_INVALID_ERROR
- VERIFICATION_TOKEN_EXPIRED_ERROR
- IDENTIFIER_CHANGE_TOKEN_INVALID_ERROR
- IDENTIFIER_CHANGE_TOKEN_EXPIRED_ERROR
- PASSWORD_RESET_TOKEN_INVALID_ERROR
- PASSWORD_RESET_TOKEN_EXPIRED_ERROR
- NOT_VERIFIED_ERROR
- NO_ACTIVE_ORDER_ERROR
GlobalFlag
- TRUE
- FALSE
- INHERIT
HistoryEntryType
- CUSTOMER_REGISTERED
- CUSTOMER_VERIFIED
- CUSTOMER_DETAIL_UPDATED
- CUSTOMER_ADDED_TO_GROUP
- CUSTOMER_REMOVED_FROM_GROUP
- CUSTOMER_ADDRESS_CREATED
- CUSTOMER_ADDRESS_UPDATED
- CUSTOMER_ADDRESS_DELETED
- CUSTOMER_PASSWORD_UPDATED
- CUSTOMER_PASSWORD_RESET_REQUESTED
- CUSTOMER_PASSWORD_RESET_VERIFIED
- CUSTOMER_EMAIL_UPDATE_REQUESTED
- CUSTOMER_EMAIL_UPDATE_VERIFIED
- CUSTOMER_NOTE
- ORDER_STATE_TRANSITION
- ORDER_PAYMENT_TRANSITION
- ORDER_FULFILLMENT
- ORDER_CANCELLATION
- ORDER_REFUND_TRANSITION
- ORDER_FULFILLMENT_TRANSITION
- ORDER_NOTE
- ORDER_COUPON_APPLIED
- ORDER_COUPON_REMOVED
- ORDER_MODIFIED
LanguageCode
Languages in the form of a ISO 639-1 language code with optional region or script modifier (e.g. de_AT). The selection available is based on the Unicode CLDR summary list and includes the major spoken languages of the world and any widely-used variants.
- // Afrikaans
- af
- // Akan
- ak
- // Albanian
- sq
- // Amharic
- am
- // Arabic
- ar
- // Armenian
- hy
- // Assamese
- as
- // Azerbaijani
- az
- // Bambara
- bm
- // Bangla
- bn
- // Basque
- eu
- // Belarusian
- be
- // Bosnian
- bs
- // Breton
- br
- // Bulgarian
- bg
- // Burmese
- my
- // Catalan
- ca
- // Chechen
- ce
- // Chinese
- zh
- // Simplified Chinese
- zh_Hans
- // Traditional Chinese
- zh_Hant
- // Church Slavic
- cu
- // Cornish
- kw
- // Corsican
- co
- // Croatian
- hr
- // Czech
- cs
- // Danish
- da
- // Dutch
- nl
- // Flemish
- nl_BE
- // Dzongkha
- dz
- // English
- en
- // Australian English
- en_AU
- // Canadian English
- en_CA
- // British English
- en_GB
- // American English
- en_US
- // Esperanto
- eo
- // Estonian
- et
- // Ewe
- ee
- // Faroese
- fo
- // Finnish
- fi
- // French
- fr
- // Canadian French
- fr_CA
- // Swiss French
- fr_CH
- // Fulah
- ff
- // Galician
- gl
- // Ganda
- lg
- // Georgian
- ka
- // German
- de
- // Austrian German
- de_AT
- // Swiss High German
- de_CH
- // Greek
- el
- // Gujarati
- gu
- // Haitian Creole
- ht
- // Hausa
- ha
- // Hebrew
- he
- // Hindi
- hi
- // Hungarian
- hu
- // Icelandic
- is
- // Igbo
- ig
- // Indonesian
- id
- // Interlingua
- ia
- // Irish
- ga
- // Italian
- it
- // Japanese
- ja
- // Javanese
- jv
- // Kalaallisut
- kl
- // Kannada
- kn
- // Kashmiri
- ks
- // Kazakh
- kk
- // Khmer
- km
- // Kikuyu
- ki
- // Kinyarwanda
- rw
- // Korean
- ko
- // Kurdish
- ku
- // Kyrgyz
- ky
- // Lao
- lo
- // Latin
- la
- // Latvian
- lv
- // Lingala
- ln
- // Lithuanian
- lt
- // Luba-Katanga
- lu
- // Luxembourgish
- lb
- // Macedonian
- mk
- // Malagasy
- mg
- // Malay
- ms
- // Malayalam
- ml
- // Maltese
- mt
- // Manx
- gv
- // Maori
- mi
- // Marathi
- mr
- // Mongolian
- mn
- // Nepali
- ne
- // North Ndebele
- nd
- // Northern Sami
- se
- // Norwegian Bokmål
- nb
- // Norwegian Nynorsk
- nn
- // Nyanja
- ny
- // Odia
- or
- // Oromo
- om
- // Ossetic
- os
- // Pashto
- ps
- // Persian
- fa
- // Dari
- fa_AF
- // Polish
- pl
- // Portuguese
- pt
- // Brazilian Portuguese
- pt_BR
- // European Portuguese
- pt_PT
- // Punjabi
- pa
- // Quechua
- qu
- // Romanian
- ro
- // Moldavian
- ro_MD
- // Romansh
- rm
- // Rundi
- rn
- // Russian
- ru
- // Samoan
- sm
- // Sango
- sg
- // Sanskrit
- sa
- // Scottish Gaelic
- gd
- // Serbian
- sr
- // Shona
- sn
- // Sichuan Yi
- ii
- // Sindhi
- sd
- // Sinhala
- si
- // Slovak
- sk
- // Slovenian
- sl
- // Somali
- so
- // Southern Sotho
- st
- // Spanish
- es
- // European Spanish
- es_ES
- // Mexican Spanish
- es_MX
- // Sundanese
- su
- // Swahili
- sw
- // Congo Swahili
- sw_CD
- // Swedish
- sv
- // Tajik
- tg
- // Tamil
- ta
- // Tatar
- tt
- // Telugu
- te
- // Thai
- th
- // Tibetan
- bo
- // Tigrinya
- ti
- // Tongan
- to
- // Turkish
- tr
- // Turkmen
- tk
- // Ukrainian
- uk
- // Urdu
- ur
- // Uyghur
- ug
- // Uzbek
- uz
- // Vietnamese
- vi
- // Volapük
- vo
- // Welsh
- cy
- // Western Frisian
- fy
- // Wolof
- wo
- // Xhosa
- xh
- // Yiddish
- yi
- // Yoruba
- yo
- // Zulu
- zu
LogicalOperator
- AND
- OR
Permission
Permissions for administrators and customers. Used to control access to GraphQL resolvers via the {@link Allow} decorator.
- // Authenticated means simply that the user is logged in
- Authenticated
- // SuperAdmin has unrestricted access to all operations
- SuperAdmin
- // Owner means the user owns this entity, e.g. a Customer’s own Order
- Owner
- // Public means any unauthenticated user may perform the operation
- Public
- // Grants permission to create Catalog
- CreateCatalog
- // Grants permission to read Catalog
- ReadCatalog
- // Grants permission to update Catalog
- UpdateCatalog
- // Grants permission to delete Catalog
- DeleteCatalog
- // Grants permission to create Customer
- CreateCustomer
- // Grants permission to read Customer
- ReadCustomer
- // Grants permission to update Customer
- UpdateCustomer
- // Grants permission to delete Customer
- DeleteCustomer
- // Grants permission to create Administrator
- CreateAdministrator
- // Grants permission to read Administrator
- ReadAdministrator
- // Grants permission to update Administrator
- UpdateAdministrator
- // Grants permission to delete Administrator
- DeleteAdministrator
- // Grants permission to create Order
- CreateOrder
- // Grants permission to read Order
- ReadOrder
- // Grants permission to update Order
- UpdateOrder
- // Grants permission to delete Order
- DeleteOrder
- // Grants permission to create Promotion
- CreatePromotion
- // Grants permission to read Promotion
- ReadPromotion
- // Grants permission to update Promotion
- UpdatePromotion
- // Grants permission to delete Promotion
- DeletePromotion
- // Grants permission to create Settings
- CreateSettings
- // Grants permission to read Settings
- ReadSettings
- // Grants permission to update Settings
- UpdateSettings
- // Grants permission to delete Settings
- DeleteSettings
SortOrder
- ASC
- DESC