Catalog

id
Adelya Internal object ID
Alphanumeric (even if yet just number are in), it's the table primary key, returned on persist or use for fast look-up
idExternal
Your reference
Alpha
255 characters max
type
CAT (always)
255 characters max
Subtype
Alpha
255 characters max
status
Catalog status
INACTIVE, DRAFT, ACTIVE, ERROR, BLOCKED
50 characters max
descr
A title
brief
A long description
image
Image URL
URL String
255 characters max
tags
comma separated list of strings
255 characters max
defaultLanguage
2 chars ISO code
2 characters max
inherit
Indicate if visible by subgroups
0 or 1
fidelOnly
If the catalog is reserved for members of one of the loyalty programs
0 or 1
seqOrder
A sorting index, if needed
Integer
dateCreate
datetime
dateValidFrom
date
dateValidUntil
date
locked
A locked component cannot be modified
0 or 1
archive
An archived status
0 or 1
manager
Email of the component manager, (e.g. who will recieve notifications)
email
255 characters max
publishable
Can it be published?
0 or 1
group
Who "owns" this component
see Group

Import Servlet

In order to import Categories and Items, we have created dedicated endpoints :

https://qa.adelya.com/loyaltyoperator/ImportCatalog.do
This endpoint use ";" as fields separator, and headers are inside CSV files

Parameters :

Datas
- idCatalog : id of target catalog
- encoding : encoding data (default is UTF-8)
Categories
- categoryUpdateModeInputName : update mode (available values : CREATE_OR_UPDATE, UPDATE_ONLY, CREATE_ONLY)
- categoryCSVInputName : InputStream for the Categories CSV file
Items
- itemUpdateModeInputName : update mode (available values : CREATE_OR_UPDATE, UPDATE_ONLY, CREATE_ONLY)
- itemCSVInputName : InputStream for the Items CSV file

Examples

Paramters samples values

Datas
- idCatalog : 555
- encoding : UTF-8
Categories
- categoryUpdateModeInputName : CREATE_OR_UPDATE
- categoryCSVInputName : categories-file.csv
Items
- itemUpdateModeInputName : CREATE_OR_UPDATE
- itemCSVInputName : items-file.csv

Curl example

Using Curl : curl -k -X POST 'https://localhost:8443/loyaltyoperator/ImportCatalog.do' \ --header 'Authorization: Basic ' \ --header 'Content-Type: multipart/form-data' \ -F 'idCatalog="35726"' \ -F 'encoding="UTF-8"' \ -F categoryCSVInputName=@"/mnt/c/adelya/TU/in/dataCateg.csv" \ -F itemCSVInputName=@"/mnt/c/adelya/TU/in/dataItem.csv"