Enums

AdjustmentType

TAX
PROMOTION
SHIPPING
REFUND
TAX_REFUND
PROMOTION_REFUND
SHIPPING_REFUND

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
CHE
// Swiss franc
CHW
// 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

HistoryEntryType

ORDER_STATE_TRANSITION
ORDER_PAYMENT_TRANSITION
ORDER_FULLFILLMENT
ORDER_CANCELLATION
ORDER_REFUND_TRANSITION
ORDER_NOTE
ORDER_COUPON_APPLIED
ORDER_COUPON_REMOVED

LanguageCode

ISO 639-1 language code

// Afar
aa
// Abkhazian
ab
// Afrikaans
af
// Akan
ak
// Albanian
sq
// Amharic
am
// Arabic
ar
// Aragonese
an
// Armenian
hy
// Assamese
as
// Avaric
av
// Avestan
ae
// Aymara
ay
// Azerbaijani
az
// Bashkir
ba
// Bambara
bm
// Basque
eu
// Belarusian
be
// Bengali
bn
// Bihari languages
bh
// Bislama
bi
// Bosnian
bs
// Breton
br
// Bulgarian
bg
// Burmese
my
// Catalan; Valencian
ca
// Chamorro
ch
// Chechen
ce
// Chinese
zh
// Church Slavic; Old Slavonic; Church Slavonic; Old Bulgarian; Old Church Slavonic
cu
// Chuvash
cv
// Cornish
kw
// Corsican
co
// Cree
cr
// Czech
cs
// Danish
da
// Divehi; Dhivehi; Maldivian
dv
// Dutch; Flemish
nl
// Dzongkha
dz
// English
en
// Esperanto
eo
// Estonian
et
// Ewe
ee
// Faroese
fo
// Fijian
fj
// Finnish
fi
// French
fr
// Western Frisian
fy
// Fulah
ff
// Georgian
ka
// German
de
// Gaelic; Scottish Gaelic
gd
// Irish
ga
// Galician
gl
// Manx
gv
// Greek, Modern (1453-)
el
// Guarani
gn
// Gujarati
gu
// Haitian; Haitian Creole
ht
// Hausa
ha
// Hebrew
he
// Herero
hz
// Hindi
hi
// Hiri Motu
ho
// Croatian
hr
// Hungarian
hu
// Igbo
ig
// Icelandic
is
// Ido
io
// Sichuan Yi; Nuosu
ii
// Inuktitut
iu
// Interlingue; Occidental
ie
// Interlingua (International Auxiliary Language Association)
ia
// Indonesian
id
// Inupiaq
ik
// Italian
it
// Javanese
jv
// Japanese
ja
// Kalaallisut; Greenlandic
kl
// Kannada
kn
// Kashmiri
ks
// Kanuri
kr
// Kazakh
kk
// Central Khmer
km
// Kikuyu; Gikuyu
ki
// Kinyarwanda
rw
// Kirghiz; Kyrgyz
ky
// Komi
kv
// Kongo
kg
// Korean
ko
// Kuanyama; Kwanyama
kj
// Kurdish
ku
// Lao
lo
// Latin
la
// Latvian
lv
// Limburgan; Limburger; Limburgish
li
// Lingala
ln
// Lithuanian
lt
// Luxembourgish; Letzeburgesch
lb
// Luba-Katanga
lu
// Ganda
lg
// Macedonian
mk
// Marshallese
mh
// Malayalam
ml
// Maori
mi
// Marathi
mr
// Malay
ms
// Malagasy
mg
// Maltese
mt
// Mongolian
mn
// Nauru
na
// Navajo; Navaho
nv
// Ndebele, South; South Ndebele
nr
// Ndebele, North; North Ndebele
nd
// Ndonga
ng
// Nepali
ne
// Norwegian Nynorsk; Nynorsk, Norwegian
nn
// Bokmål, Norwegian; Norwegian Bokmål
nb
// Norwegian
no
// Chichewa; Chewa; Nyanja
ny
// Occitan (post 1500); Provençal
oc
// Ojibwa
oj
// Oriya
or
// Oromo
om
// Ossetian; Ossetic
os
// Panjabi; Punjabi
pa
// Persian
fa
// Pali
pi
// Polish
pl
// Portuguese
pt
// Pushto; Pashto
ps
// Quechua
qu
// Romansh
rm
// Romanian; Moldavian; Moldovan
ro
// Rundi
rn
// Russian
ru
// Sango
sg
// Sanskrit
sa
// Sinhala; Sinhalese
si
// Slovak
sk
// Slovenian
sl
// Northern Sami
se
// Samoan
sm
// Shona
sn
// Sindhi
sd
// Somali
so
// Sotho, Southern
st
// Spanish; Castilian
es
// Sardinian
sc
// Serbian
sr
// Swati
ss
// Sundanese
su
// Swahili
sw
// Swedish
sv
// Tahitian
ty
// Tamil
ta
// Tatar
tt
// Telugu
te
// Tajik
tg
// Tagalog
tl
// Thai
th
// Tibetan
bo
// Tigrinya
ti
// Tonga (Tonga Islands)
to
// Tswana
tn
// Tsonga
ts
// Turkmen
tk
// Turkish
tr
// Twi
tw
// Uighur; Uyghur
ug
// Ukrainian
uk
// Urdu
ur
// Uzbek
uz
// Venda
ve
// Vietnamese
vi
// Volapük
vo
// Welsh
cy
// Walloon
wa
// Wolof
wo
// Xhosa
xh
// Yiddish
yi
// Yoruba
yo
// Zhuang; Chuang
za
// Zulu
zu

Permission

“ Permissions for administrators and customers. Used to control access to GraphQL resolvers via the {@link Allow} decorator.

// The Authenticated role means simply that the user is logged in
Authenticated
// SuperAdmin can perform the most sensitive tasks
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
CreateCatalog
ReadCatalog
UpdateCatalog
DeleteCatalog
CreateCustomer
ReadCustomer
UpdateCustomer
DeleteCustomer
CreateAdministrator
ReadAdministrator
UpdateAdministrator
DeleteAdministrator
CreateOrder
ReadOrder
UpdateOrder
DeleteOrder
CreatePromotion
ReadPromotion
UpdatePromotion
DeletePromotion
CreateSettings
ReadSettings
UpdateSettings
DeleteSettings

SortOrder

ASC
DESC

StockMovementType

ADJUSTMENT
SALE
CANCELLATION
RETURN