NOTE: Data Model is still in development stage and might have breaking changes on upcoming days
IMPORTANT NOTES:
10/25/2021: ProductType field is updated as Array<string> whose values are based on data managed with the new ProductTypes endpoints.
10/22/2021: Moved other barcode related fields to variant level
10/20/2021: ProductType field schema will be updated in upcoming days to have a separate DB for product categories
...
| Code Block |
|---|
enum PriceListTypeEnum {
Standard = 'Standard',
Promotional = 'Promotional',
}
enum ProductStatusEnum {
Active = 'Active',
Inactive = 'Inactive',
Discontinued = 'Discontinued',
Dormant = 'Dormant',
Frozen = 'Frozen',
Replaced = 'Replaced',
Obsolete = 'Obsolete',
Abandoned = 'Abandoned',
Blocked = 'Blocked',
}
enum IsoLanguageIds {
af_ZA = 'af-ZA',
am_ET = 'am-ET',
ar_AE = 'ar-AE',
ar_BH = 'ar-BH',
ar_DZ = 'ar-DZ',
ar_EG = 'ar-EG',
ar_IQ = 'ar-IQ',
ar_JO = 'ar-JO',
ar_KW = 'ar-KW',
ar_LB = 'ar-LB',
ar_LY = 'ar-LY',
ar_MA = 'ar-MA',
ar_OM = 'ar-OM',
ar_QA = 'ar-QA',
ar_SA = 'ar-SA',
ar_SY = 'ar-SY',
ar_TN = 'ar-TN',
ar_YE = 'ar-YE',
as_IN = 'as-IN',
ba_RU = 'ba-RU',
be_BY = 'be-BY',
bg_BG = 'bg-BG',
bn_BD = 'bn-BD',
bn_IN = 'bn-IN',
bo_CN = 'bo-CN',
br_FR = 'br-FR',
ca_ES = 'ca-ES',
co_FR = 'co-FR',
cs_CZ = 'cs-CZ',
cy_GB = 'cy-GB',
da_DK = 'da-DK',
de_AT = 'de-AT',
de_CH = 'de-CH',
de_DE = 'de-DE',
de_LI = 'de-LI',
de_LU = 'de-LU',
dv_MV = 'dv-MV',
el_GR = 'el-GR',
en_AU = 'en-AU',
en_BZ = 'en-BZ',
en_CA = 'en-CA',
en_GB = 'en-GB',
en_IE = 'en-IE',
en_IN = 'en-IN',
en_JM = 'en-JM',
en_MY = 'en-MY',
en_NZ = 'en-NZ',
en_PH = 'en-PH',
en_SG = 'en-SG',
en_TT = 'en-TT',
en_US = 'en-US',
en_ZA = 'en-ZA',
en_ZW = 'en-ZW',
es_AR = 'es-AR',
es_BO = 'es-BO',
es_CL = 'es-CL',
es_CO = 'es-CO',
es_CR = 'es-CR',
es_DO = 'es-DO',
es_EC = 'es-EC',
es_ES = 'es-ES',
es_GT = 'es-GT',
es_HN = 'es-HN',
es_MX = 'es-MX',
es_NI = 'es-NI',
es_PA = 'es-PA',
es_PE = 'es-PE',
es_PR = 'es-PR',
es_PY = 'es-PY',
es_SV = 'es-SV',
es_US = 'es-US',
es_UY = 'es-UY',
es_VE = 'es-VE',
et_EE = 'et-EE',
eu_ES = 'eu-ES',
fa_IR = 'fa-IR',
fi_FI = 'fi-FI',
fo_FO = 'fo-FO',
fr_BE = 'fr-BE',
fr_CA = 'fr-CA',
fr_CH = 'fr-CH',
fr_FR = 'fr-FR',
fr_LU = 'fr-LU',
fr_MC = 'fr-MC',
fy_NL = 'fy-NL',
ga_IE = 'ga-IE',
gd_GB = 'gd-GB',
gl_ES = 'gl-ES',
gu_IN = 'gu-IN',
he_IL = 'he-IL',
hi_IN = 'hi-IN',
hr_BA = 'hr-BA',
hr_HR = 'hr-HR',
hu_HU = 'hu-HU',
hy_AM = 'hy-AM',
id_ID = 'id-ID',
ig_NG = 'ig-NG',
ii_CN = 'ii-CN',
is_IS = 'is-IS',
it_CH = 'it-CH',
it_IT = 'it-IT',
ja_JP = 'ja-JP',
ka_GE = 'ka-GE',
kk_KZ = 'kk-KZ',
kl_GL = 'kl-GL',
km_KH = 'km-KH',
kn_IN = 'kn-IN',
ko_KR = 'ko-KR',
ky_KG = 'ky-KG',
lb_LU = 'lb-LU',
lo_LA = 'lo-LA',
lt_LT = 'lt-LT',
lv_LV = 'lv-LV',
mi_NZ = 'mi-NZ',
mk_MK = 'mk-MK',
ml_IN = 'ml-IN',
mn_MN = 'mn-MN',
mr_IN = 'mr-IN',
ms_BN = 'ms-BN',
ms_MY = 'ms-MY',
mt_MT = 'mt-MT',
nb_NO = 'nb-NO',
ne_NP = 'ne-NP',
nl_BE = 'nl-BE',
nl_NL = 'nl-NL',
nn_NO = 'nn-NO',
oc_FR = 'oc-FR',
or_IN = 'or-IN',
pa_IN = 'pa-IN',
pl_PL = 'pl-PL',
ps_AF = 'ps-AF',
pt_BR = 'pt-BR',
pt_PT = 'pt-PT',
rm_CH = 'rm-CH',
ro_RO = 'ro-RO',
ru_RU = 'ru-RU',
rw_RW = 'rw-RW',
sa_IN = 'sa-IN',
se_FI = 'se-FI',
se_NO = 'se-NO',
se_SE = 'se-SE',
si_LK = 'si-LK',
sk_SK = 'sk-SK',
sl_SI = 'sl-SI',
sq_AL = 'sq-AL',
sv_FI = 'sv-FI',
sv_SE = 'sv-SE',
sw_KE = 'sw-KE',
ta_IN = 'ta-IN',
te_IN = 'te-IN',
th_TH = 'th-TH',
tk_TM = 'tk-TM',
tn_ZA = 'tn-ZA',
tr_TR = 'tr-TR',
tt_RU = 'tt-RU',
ug_CN = 'ug-CN',
uk_UA = 'uk-UA',
ur_PK = 'ur-PK',
vi_VN = 'vi-VN',
wo_SN = 'wo-SN',
xh_ZA = 'xh-ZA',
yo_NG = 'yo-NG',
zh_CN = 'zh-CN',
zh_HK = 'zh-HK',
zh_MO = 'zh-MO',
zh_SG = 'zh-SG',
zh_TW = 'zh-TW',
zu_ZA = 'zu-ZA',
}
|
Field Definitions (Work in progress):
Field | Description | Required | Example |
|---|---|---|---|
| Primary ID of the product | Yes | product1 |
| Name of client whom the data belongs | Yes | Kjell |
| List of customers associated with the product | Ombori, Kjell | |
| Date when product is available/added | 2012-05-05 | |
| Date when product is to be abandoned | 2030-05-05 | |
| 30 | ||
| Product Name | Yes | |
CountryId | Country ID | Yes | 46 |
IsoLanguageId | Iso Language ID | Yes | |
ProductName | Translation value of the product name | Yes | |
| Product Name | Yes | |
CountryId | Country ID | Yes | 46 |
IsoLanguageId | Iso Language ID | Yes | |
ProductDescription | Translation value of the product description | Yes | |
| Yes | ||
| Variant ID | Yes | |
| Product ID where variant belongs to | Yes | |
| |||
| |||
| |||
| |||
| Date when variant was added | ||
| Date when variant will end | ||
| Variant’s Product Name | No | |
CountryId | Country ID | Yes | 46 |
IsoLanguageId | Iso Language ID | Yes | |
ProductName | Translation value of the variant’s product name | Yes | |
| Yes | ||
ProductStatus | Status value of the product | Yes | Active | Inactive |
CountryId | Country ID where status is applicable | Yes | 46 |
IsoLanguageId | Iso Language ID | Yes | |
StoreId | Store ID where product status is applicable | ||
PeriodStartDate | Status duration start | ||
PeriodEndDate | Status duration end | ||
ProductStatusNote | |||
| Set of features of the product | No | |
Id | SKU or Variant ID | Yes | |
ProductFeatureType | Key of the product feature | Yes | |
ProductFeatureValue | Translated value of the product feature | Yes | |
CountryId | Country ID | Yes | 46 |
IsoLanguageId | Iso Language ID | Yes | |
| List of product prices per variant | Yes | |
Id | SKU or Variant ID | Yes | |
PriceListType | Standard or Promotional | Yes | Standard |
StoreId | Store where price list is applicable | ||
CountryId | Country ID | Yes | 46 |
IsoLanguageId | Iso Language ID | Yes | |
IsoCurrencyCode | Iso Currency Code | Yes | |
PricingUomId | |||
PeriodStartTimestamp | Price applicable start date | ||
PeriodEndTimestamp | Price applicable start date | ||
SuggestedRetailPrice | |||
ListPrice | Yes | ||
| |||
Id | SKU or Variant ID | Yes | |
ProductId | Parent Id | Yes | |
CatalogType | Type of the image/media | image/png | |
CatalogPage | Root URL where image/media is found | ||
CatalogPageLocation | ID or route where image/media is found | /product/12345 | |
CatalogPageLocationProduct | Entire URL where image/media is found | Yes | |
| Stickers or labels associated with the product | No | |
CountryId | Country ID | Yes | 46 |
IsoLanguageId | Iso Language ID | Yes | |
ProductLabel | Translation value of Product Label | Yes | |
| Contains inventory / quantity | No | |
Id | SKU or variant ID | Yes | |
StoreId | Store where quantity/inventory is applicable | ||
ProductItemQuantityStartDate | Quantity start date | ||
ProductItemQuantityEndDate | Quantity end date | ||
ProductItemQuantity | Product quantity value | Yes | |
| Short description of the product | No | |
CountryId | Country ID | Yes | 46 |
IsoLanguageId | Iso Language ID | Yes | |
ProductShortDescription | Translation value of short description | Yes | |
| Internal name of the product | No | |
CountryId | Country ID | Yes | 46 |
IsoLanguageId | Iso Language ID | Yes | |
ProductInternalName | Translation value of internal name | Yes | |
| Storage instructions | No | |
CountryId | Country ID | Yes | 46 |
IsoLanguageId | Iso Language ID | Yes | |
StorageInstructions | Translation value of storage instructions | Yes | |
| Consumer storage instruction | No | |
CountryId | Country ID | Yes | 46 |
IsoLanguageId | Iso Language ID | Yes | |
ConsumerStorageInstruction | Translation value of consumer storage instructions | Yes | |
| Consumer storage instruction | No | |
CountryId | Country ID | Yes | 46 |
IsoLanguageId | Iso Language ID | Yes | |
ProductShippingInstruction | Translation value of product shipping instructions | Yes | |
| List of Product Type of a product referenced from ProductTypes DB | Yes |
...