Akcje

W Comarch e-Sklep udostępniliśmy do Państwa dyspozycji Akcje.

Uwaga
Akcje są to działania na stronie związane z interakcją użytkownika (kupującego jak i zarządzającego sklepem), takie jak np. dokonywanie zakupów, dodawanie produktów do koszyka czy zmiana waluty.

Lista dostępnych akcji znajduje się w Panelu Administracyjnym sklepu w następującej ścieżce: Panel administracyjny/Wygląd sklepu/Dokumentacja.

 

Związane z Klientem

Akcje te możemy określić jako powiązane z Klientem i jego działaniami na stronie. W skład tych akcji wchodzą:

CompanyChange

Akcja odpowiada za zmianę firmy. Zawiera jedno pole – Id – jest to pole obowiązkowe, typu int.

 

CompanyDefaultUpdate

Akcja odpowiada za wczytanie domyślnych ustawień firmy. Zawiera jedno pole – Id – jest to pole obowiązkowe, typu int.

 

ConsentAccept

Akcja odpowiadająca za akceptację zgody, na przykład podczas składania zamówienia. Zawiera następujące pola:

  1. tos – pole może przyjąć typ int lub pozostać puste
  2. channelKey – pole typu string
 

ConsentsLoginAccept

Akcja odpowiadająca za akceptację zgody obowiązkowej podczas logowania. Zawiera następujące pola:

  1. tos – przyjmuje wartość int[] – dane pole może zostać przekazane wielokrotnie w ramach jednej akcji, wartość int
  2. channelKey pole typu string[] – dane pole może zostać przekazane wielokrotnie w ramach jednej akcji
 

ConsentWithdraw

Akcja odpowiada za wycofanie zgody. Zawiera następujące pola:

  1. tos – pole to może przyjąć wartość int lub pozostać puste
  2. channelKey – pole typu string

 

CurrencyChange

Akcja odpowiada za zmianę waluty. Zawiera jedno pole – currency. Jest to pole obowiązkowe.

DeliveryAddressAdd

Akcja odpowiada za dodanie adresu do dostawy. Formularz zawiera następujące pola:

  1. addressId – pole to może przyjąć wartość int lub pozostać puste
  2. default – pole to przyjmuje wartość bool (true/false)
  3. name – pole obowiązkowe, maksymalna długość tego pola to 64 znaków
  4. name2 – maksymalna długość tego pola to 64 znaków
  5. name3 – maksymalna długość tego pola to 250 znaków
  6. street – maksymalna długość tego pola to 150 znaków
  7. streetNo – maksymalna długość tego pola to 20 znaków
  8. unitNo – maksymalna długość tego pola to 20 znaków
  9. zipCode – pole wymagane, maksymalna długość tego pola to 20 znaków
  10. city – maksymalna długość tego pola to 50 znaków
  11. countryCode – pole obowiązkowe, maksymalna długość to 2 znaki
  12. state – maksymalna długość tego pola to 50 znaków
  13. phoneNo – maksymalna długość tego pola to 50 znaków
 

DeliveryAddressDelete

Umożliwia usunięcie adresu dostawy.
Zawiera jedno pole – addressId – jest to pole obowiązkowe typu int.

 

DeliveryAddressUpdate

Umożliwia edycję adresu.

Akcja ta posiada następujące pola:

  1. addressId – pole może przyjąć typ int lub pozostać puste
  2. default – pole przyjmuje wartość bool (true/false)
  3. name – pole obowiązkowe, maksymalna długość tego pola to 64 znaków
  4. name2 – maksymalna długość tego pola to 64 znaków
  5. name3 – maksymalna długość tego pola to 250 znaków
  6. countryCode – pole obowiązkowe, maksymalna długość to 2 znaki
  7. zipCode – maksymalna długość tego pola to 20 znaków
  8. city – maksymalna długość tego pola to 50 znaków
  9. street – maksymalna długość tego pola to 150 znaków
  10. streetNo – maksymalna długość tego pola to 20 znaków
  11. unitNo – maksymalna długość tego pola to 20 znaków
  12. state – maksymalna długość tego pola to 50 znaków
  13. phoneNo – maksymalna długość tego pola to 50 znaków
 

EmailChange

Akcja odpowiadająca zmianie adresu e-mail. Przyjmuje następujące pola:

  1. email – pole obowiązkowe,wyrażenie regularne, maksymalna długość to 192 znaki
  2. emailRepeat – pole obowiązkowe,wyrażenie regularne, maksymalna długość to 192 znaki
  3. password – pole obowiązkowe

W przypadku wersji enterprise występuje pole doNotChangeCompanyEmail – jest to pole wartości bool (true/false).

 

EmployeeAdd
Akcja odpowiada za dodanie pracownika.
Posiada jedno pole – email. Jest to pole wymagane,wyrażenie regularne, maksymalna długość to 192 znaki.

 

EmployeeDelete

Akcja odpowiada za usunięcie pracownika.

Posiada jedno pole – id. Jest to pole wymagane, typu int.

 

EmployeeLock
Akcja odpowiada za zablokowanie pracownika. Posiada pole id – pole wymagane typu int.

 

EmployeeUnock
Akcja odpowiada za odblokowanie pracownika. Posiada pole id – pole wymagane typu int.

EmployeeUpdate

Akcja ta odpowiada za aktualizację danych pracowników w profilu. Zawiera następujące pola:

  1. name – maksymalna długość tego pola to 50 znaków
  2. name2 – maksymalna długość tego pola to 50 znaków
  3. phoneNo – maksymalna długość tego pola to 50 znaków
  4. languageId – pole to może przyjąć typ int lub pozostać puste
 

LanguageChange
Odpowiada za wybór i zmianę języka w sklepie.
Posiada jedno pole – languageId – jest to pole wymagane typu short.

 

LanguageDefaultUpdate
Odpowiada za ustawienie domyślnego języka.
Posiada jedno pole – languageId – jest to pole wymagane typu short.
 

Login

Akcja odpowiadająca za logowanie. Zawiera następujące pola:

  1. email – pole wymagane,wyrażenie regularne, maksymalna długość tego pola to 192 znaki
  2. password – pole wymagane
  3. remember – pole typu bool (true/false)
 

Logout

Akcja ta odpowiada za wylogowanie zalogowanego użytkownika (Klienta).

 

OldPasswordChange

Akcja odpowiada za zmianę hasła, zawiera trzy pola, są to:

  1. oldPassword – pole wymagane
  2. password – pole wymagane
  3. passwordRepeat – pole wymagane
 

PasswordChange

Akcja odpowiadająca za zmianę hasła (np. przy pomocy formularza ,,zapomniałem hasła”). Pola jakie przyjmuje to:

  1. password – pole wymagane
  2. passwordRepeat – pole wymagane
  3. hash – pole wymagane
 

PasswordRecover

Akcja której zadaniem jest odzyskanie hasła. Zawiera jedno pole email – pole wymagane,wyrażenie regularne, maksymalna długość to 192 znaki.

 

Register

Akcja ta odpowiada za rejestrację użytkownika, zawiera następujące pola:

  1. company – pole przyjmuje wartość bool (true/false)
  2. email – pole wymagane,wyrażenie regularne, maksymalna długość to 192 znaki
  3. password – pole wymagane
  4. passwordRepeat – pole typu string
  5. phoneNo – maksymalna długość to 50 znaków
  6. name – maksymalna długość to 64 znaków
  7. name2 – maksymalna długość to 64 znaków
  8. name3 – maksymalna długość to 250 znaków
  9. countryCode – maksymalna długość to 2 znaki
  10. zipCode – maksymalna długość to 20 znaków
  11. city – maksymalna długość pola to 50 znaków
  12. street – maksymalna długość pola to 150 znaków
  13. streetNo – maksymalna długość pola to 20 znaków
  14. unitNo – masymalna długość pola to 20 znaków
  15. state – maksymalna długość pola to 50 znaków
  16. tin – makymalna długość pola to 20 znaków
  17. ssn – maksymalna długość pola to 20 znaków
  18. tos – przyjmuje wartość int[] – dane pole może zostać przekazane wielokrotnie w ramach jednej akcji, wartość int
  19. channelKey – pole typu string[] – dane pole może zostać przekazane wielokrotnie w ramach jednej akcji

Dodatkowo, dla wersji enterprise dostępne jest pole vateu – maksymalna długość tego pola to 2 znaki.

Uwaga
W przypadku użytkowników nie będących firmami pola obowiązkowe to jedynie mail oraz password, przykładowy kod dla takiego rozwiązania zawierał by więc jedynie te dwa pola.

 

 

ReviewAuthorUpdate

Odpowiada za dodanie nicku dla użytkownika który dodaje opinie o produkcie. Akcja ta zawiera jedno pole – author. Jest to pole obowiązkowe, jego maksymalna długość to 50 znaków.

 

Update

Akcja odpowiadająca za zmianę danych konta. Zawiera następujące pola:

  1. email – wyrażenie regularne, maksymalna długość pola wynosi 192 znaki
  2. company – przyjmuje wartość bool (true/false)
  3. name -pole wymagane, maksymalna długość do 64 znaków
  4. name2 – maksymalna długość to 64 znaków
  5. name3 – maksymalna długość to 250 znaków
  6. countryCode – pole wymagane, maksymalna długość to dwa znaki
  7. zipCode – maksymalna długość pola wynosi 20 znaków
  8. city – maksymalna długość pola to 50 znaków
  9. street – maksymalna długość tego pola wynosi 150
  10. streetNo – maksymalna długość tego pola wynosi 20 znaków
  11. unitNo – maksymalna długość tego pola wynosi 20 znaków
  12. state – maksymalna długość tego pola wynosi 50 znaków
  13. phoneNo – maksymalna długość tego pola wynosi 50 znaków
  14. tin – maksymalna długość tego pola wynosi 20 znaków
  15. ssn – maksymalna długość tego pola wynosi 20 znaków
  16. invoice – przyjmuje wartość bool (true/false)

Dodatkowo, dla wersji enterprise przewidziano pola:

  1. vateu – maksymalna długość dla tego pola wynosi 2 znaki
  2. subtotalPrices – pole wartości bool (true/false)
 

Dotyczące zamówienia

Akcje w tej grupie dotyczą składanych zamówień.

Accept

Umożliwia akceptację zamówienia w sytuacji, gdy mamy do czynienia z np. negocjowalnym kosztem transportu. Zawiera następujące pola:

  1. id – pole typu int, przyjmuje wartość id
  2. hash – pole typu string
 

Add

Odpowiada za dodanie zamówienia. Zawiera następujące pola:

  1. tos – przyjmuje wartość int[] – dane pole może zostać przekazane wielokrotnie w ramach jednej akcji, wartość int
  2. channelKey – pole typu string[] – dane pole może zostać przekazane wielokrotnie w ramach jednej akcji
 

Cancel

Akcja ta odpowiada za anulowanie zamówienia. Zawiera następujące pola:

  1. id – pole wymagane, pole typu int, przyjmuje wartość id
  2. hash – pole typu string
 

AttachmentAdd

Akcja odpowiada za dodawanie załącznika do zamówienia. Zawiera jedno pole file – pole dla wczytywanych plików.

 

AttachmentDelete

Akcja odpowiada za usuwanie załącznika do zamówienia. Zawiera jedno pole id – pole wymagane.

 

AttributesSet

Akcja odpowiada za ustawienie atrybutów zamówienia. Zawiera jedno pole attribute – typu string[] – dane pole może zostać przekazane wielokrotnie w ramach jednej akcji, maksymalna długość to 1000 znaków.

 

ComplaintAdd

Akcja odpowiada za dodanie reklamacji. Akcja ta posiada następujące pola:

  1. orderId – pole wymagane, typu int
  2. no – pole wymagane, typu int
  3. quantity – pole może przyjąć wartość pomiędzy 0.01 a 99999, pole typu decimal
  4. message – maksymalna ilość znaków dla tego pola wynosi 1000
  5. accountNumber – maksymalna ilość znaków dla tego pola wynosi 50 znaków
  6. defectId – pole to może przyjąć typ int lub pozostać puste
  7. requestId – pole to może przyjąć typ int lub pozostać puste
  8. defectDate – pole wymagane, wyrażenie regularne
  9. files – pole dla wczytywanych plików

 

BuyerChange
Akcja odpowiedzialna za zmianę nabywcy. Posiada pole buyer – pole typu boolean.

BuyerUpdate
Akcja odpowiedzialna za aktualizację danych nabywcy. Posiada następujace pola:
  1. name – pole wymagane typu string. Maksymalna długość na pola to 64 znaki
  2. name2 – pole typu string. Maksymalna długość na pola to 64 znaki
  3. name3 – pole typu string. Maksymalna długość na pola to 250 znaków
  4. countryCode – pole wymagane typu string. Maksymalna długość na pola to 2 znaki
  5. zipCode – pole typu string. Maksymalna długość na pola to 20 znaków
  6. city – pole typu string. Maksymalna długość na pola to 50 znaków
  7. street – pole typu string. Maksymalna długość na pola to 150 znaków
  8. streetNo – pole typu string. Maksymalna długość na pola to 20 znaków
  9. unitNo – pole typu string. Maksymalna długość na pola to 20 znaków
  10. state – pole typu string. Maksymalna długość na pola to 50 znaków
  11. phoneNo – pole typu string. Maksymalna długość na pola to 50 znaków
  12. vateu – pole typu string. Maksymalna długość na pola to 2 znaki
  13. tin – pole typu string
  14. ssn – pole typu string. Maksymalna długość na pola to 20 znaków
  15. invoice – pole typu boolean
  16. company – pole typu boolean
ComplaintCancel
Akcja ta odpowiada za anulowanie reklamacji.
Posiada jedno pole complaintId – jest to pole wymagane, typu int.

 

Copy

Akcja odpowiadająca za kopiowanie zamówienia. Zawiera następujące pola:

  1. orderId – pole wymagane, pole typu int
  2. hash – pole typu string.
{% if customer-profile.Order != null %} {% endif %}

 

 

CouponAdd

Akcja pozwalająca na dodanie kuponu. Zawiera następujące pola:

  1. code – pole wymagane, maksymalna długość tego pola to 40 znaków
  2. email – wyrażenie regularne, maksymalna długośc tego pola to 192 znaki
 

CouponDelete

Akcja umożliwiająca usunięcie kuponu.

 

DeliveryAddressUpdate
Akcja odpowiada za uaktualnienie adresu dostawy.
Posiada następujące pola:

  1. email – pole obowiązkowe,wyrażenie regularne, maksymalna długość to 192 znaki
  2. name – pole obowiązkowe, maksymalna długość tego pola to 64 znaków
  3. name2 – maksymalna długość tego pola to 64 znaków
  4. name3 – maksymalna długość tego pola to 250 znaków
  5. zipCode – maksymalna długość tego pola to 20 znaków
  6. city – maksymalna długość tego pola to 50 znaków
  7. street – maksymalna długość tego pola to 150 znaków
  8. streetNo – maksymalna długość tego pola to 20 znaków
  9. unitNo – maksymalna długość tego pola to 20 znaków
  10. state – maksymalna długość tego pola to 50 znaków
  11. phoneNo – maksymalna długość tego pola to 50 znaków
 

DeliveryChange

Akcja odpowiedzialna za zmianę metody dostawy towaru. Zawiera następujące pola:

  1. id – pole wymagane, pole typu int
  2. channel – pole typu string
 

DeliveryCollectionPointChange

Pozwala na wybranie miejsca odbioru paczki (np. przy korzystaniu z paczkomatów). Zawiera następujące pola:

  1. id – pole wymagane, pole typu string
  2. data – pole typu string
 

DeliveryCountryChange

Akcja odpowiedzialna za zmianę kraju dostawy. Posiada jedno pole – countryCode.

 

DeliveryDateChange

Akcja odpowiada za zmianę terminu dostawy. Zawiera jedno pole date – wyrażenie regularne, typu string.

 

EmailSet

Akcja odpowiada za ustawienie adresu email. Zawiera jedno pole email – pole wymagane, wyrażenie regularne, maksymalna długość to 192 znaki.

 

InvoiceAddressUpdate

Akcja ta odpowiada za zmianę danych faktury. Zawiera następujące pola:

  1. name – pole obowiązkowe, maksymalna długość dla tego pola wynosi 64 znaków
  2. name2 – maksymalna długość tego pola wynosi 64 znaków
  3. name3 – maksymalna długość tego pola wynosi 250 znaków
  4. countryCode – pole obowiązkowe, maksymalna długość tego pola to dwa znaki
  5. zipCode – maksymalna długość tego pola wynosi 20 znaków
  6. city – maksymalna długość tego pola wynosi 50 znaków
  7. street – maksymalna długość tego pola wynosi 150 znaków
  8. streetNo – maksymalna długość tego pola wynosi 20 znaków
  9. unitNo – maksymalna długość tego pola wynosi 20 znaków
  10. state – maksymalna długość tego pola wynosi 50 znaków
  11. phoneNo – maksymalna długość dla tego pola wynosi 50 znaków
  12. tin – pole typu string
  13. ssn – maksymalna długość tego pola wynosi 20 znaków
  14. invoice – pole przyjmuje wartość bool (true/false)
  15. company – pole przyjmuje wartość bool (true/false)

Dla wersji Enterprise dodatkowo występuje pole vateu – długość tego pola wynosi maksymalnie 2 znaki.

 

InvoiceChange

Akcja odpowiada za wybranie opcji wystawienia faktury. Posiada jedno pole invoice – typu bool (true/false).

 

NoteAdd

Akcja odpowiada za dodanie wiadomości do zamówienia. Posiada jedno pole note – jego maksymalna długość to 500 znaków.

 

PaymentMake

Akcja odpowiada za dokonywanie płatności. Zawiera następujące pola:

  1. id – pole wymagane, pole typu int
  2. hash – pole wymagane, pole typu string.
 

PointsUse

Akcja odpowiada za płacenie punktami.

 

RestorePayment

Akcja odpowiada za możliwość opłacenia zamówienia gdy wcześniej się to nie udało (np. w wyniku awarii internetu). Zawiera następujące pola:

  1. id – pole wymagane typu int
  2. hash – pole typu string
 

ReturnAdd

Akcja odpowiedzialna za zwrot. Posiada następujące pola:

  1. orderID – pole wymagane, typu int
  2. no – pole wymagane, typu int
  3. quantity – pole może przyjąć wartości od 0.01 do 99999, typu int
  4. message – maksymalna długość tego pola wynosi 1000 znaków
  5. accountNumber – maksymalna długość tego pola wynosi 50 znaków
  6. returnId – pole to może pozostać puste lub przyjąć typ int
  7. files – pole wczytujące pliki
 

StatusGet

Akcja odpowiedzialna za pobranie statusu zamówienia na podstawie id i adresu e-mail. Posiada pola:

  1. id – pole obowiązkowe, typu int
  2. email- Jest to pole wymagane,wyrażenie regularne, jego maksymalna długość to 192 znaki
 

TinUpdate
Akcja odpowiedzialna za aktualizację numeru TIN. Posiada pola:

  1. vateu – pole typu string. Maksymalna długość dla pola to 2 znaki
  2. tin – pole typu string
  3. ssn – pole typu string. Maksymalna długość dla pola to 20 znaków

StepNext

Akcja odpowiadająca za kolejny krok w przypadku składania zamówienia.

 

StepPrev

Akcja odpowiedzialna za powrót do poprzedniego kroku podczas składania zamówienia.

 

Newsletter

Akcja odpowiada za działanie związane z newsletterem.

Subscribe

Kod odpowiadający za subskrypcję do newslettera. Posiada następujące pola:

  1. email – pole obowiązkowe, wyrażenie regularne, maksymalna długość dla tego pola to 192 znaki
  2. tos – przyjmuje wartość int[] – dane pole może zostać przekazane wielokrotnie w ramach jednej akcji, wartość int
  3. channelKey – pole typu string[] – dane pole może zostać przekazane wielokrotnie w ramach jednej akcji
 

Unsubscribe

Kod odpowiedzialny za wypisanie się z subskrypcji mailowej.

 

Akcje GET

Akcja ta umożliwia pobieranie danych z serwera celem utworzenia np. breadcrumbs.

CollectionPointCities

Akcja odpowiada za pobranie miast, w których znajdują się punkty odbioru. Zawiera następujące pola:

  1. country – pole typu string, maksymalna długość tego pola wynosi 2 znaki
  2. typeId – pole typu int
  3. all – pole przyjmuje wartość bool (true/false)
  4. stockLevels – pole przyjmuje wartość bool (true/false)
 

CollectionPoints

Akcja odpowiada za pobranie punktów odbioru towarów. Zawiera następujące pola:

  1. country – maksymalna długość tego pola wynosi 2 znaki
  2. city – maksymalna długość tego pola wynosi 50 znaki
  3. typeId – pole typu int
  4. all – pole przyjmuje wartość bool (true/false)
  5. stockLevels – pole przyjmuje wartość bool (true/false)
 

Groups

Pobiera grupy podrzędne dla wskazanej grupy. Akcja ta umożliwia zbudowanie dynamicznego menu czy breadcrumbs. Zawiera następujące pola:

  1. groupId – pole typu int.
  2. languageId – pole typu int.
  3. levels – pole typu int.
 

Search

Akcja odpowiada za wyszukiwarkę. Posiada jedno pole – search – jest to pole wymagane, jego maksymalna długość to 100 znaków.

 

SearchAdvanced

Akcja odpowiada za zaawansowaną wyszukiwarkę.Zawiera następujące pola:

  1. search – maksymalna długość dla tego pola wynosi 100 znaków.
  2. searchAll – maksymalna długość dla tego pola wynosi 100 znaków.
  3. searchAny – maksymalna długość dla tego pola wynosi 100 znaków.
  4. searchWild – maksymalna długość dla tego pola wynosi 100 znaków.
  5. fields – pole typu int.
  6. flags – pole typu int.
  7. priceFrom – pole to może pozostać puste lub przyjąć typ int.
  8. priceTo – pole to może pozostać puste lub przyjąć typ int.
  9. groupId – pole to może pozostać puste lub przyjąć typ int.
  10. manufactureId – pole to może pozostać puste lub przyjąć typ int.
  11. brandId – pole to może pozostać puste lub przyjąć typ int.
 

SearchAutocomplete

Akcja odpowiada za wyświetlanie podpowiedzi 5 towarów w trakcie wyszukiwania. Akcja posiada jedno pole search. Jest to pole obowiązkowe, jego maksymalna długość to 100 znaków.

 

SearchFilters

Akcja odpowiada za zastosowanie filtrów wyszukiwania. Posiada jedno pole __skipParameter. Pole typu string[] – dane pole może zostać przekazane wielokrotnie w ramach jednej akcji.

 

SearchAutocomplete

Akcja odpowiada za wyświetlanie podpowiedzi 5 towarów w trakcie wyszukiwania. Akcja posiada jedno pole search. Jest to pole obowiązkowe, jego maksymalna długość to 100 znaków.

 

ProductId
Uwaga
Akcja dostępna w sklepach B2B od wersji 2021.2.1. Do działania wymaga usługi Comarch e-Sklep Sync.
Akcja odpowiada za tłumaczenie numerów id grupy z systemu ERP (GIDNumber) na odpowiadajace im numery id ze sklepu. Posiada jedno pole gidNumbers. Pole typu int[] – będące listą numerów id grup w systemie ERP. Zwraca tablicę obiektów w postaci: [{GIDNumber: int, Id: int}, …].
Wskazówka
Akcja ta powiązana jest z z akcjami typu Sync, gdzie numery id grup produktów nie zawsze są jednoznaczne z numerami id w sklepie. W związku z tym, po pobraniu danych o produktach z bazy ERP, id produktów (GIDNumber) należy zamienić na id sklepu (na przykład za pomocą poniższej funkcji).
 

Produkty

Akcja ta odpowiada za działania związane z produktami, takimi jak możliwość dodania opinii na temat produktu.

AskForPrice

Akcja odpowiada za złożenie zapytania o cenę produktu. Zawiera następujące pola:

  1. productId – pole wymagane, typ pola to int
  2. email – pole obowiązkowe,wyrażenie regularne, maksymalna długość dla tego pola to 192 znaki
  3. phoneNo – maksymalna długość tego pola to 20 znaków
  4. quantity – pole obowiązkowe, pole przyjmuje wartość między 1 a 99999
  5. unitId – pole to może pozostać puste lub przyjąć typ int
  6. message – maksymalna długość dla tego pola wynosi 500 znaków
 

CollectionPointsStockLevelsGet

Akcja odpowiada za pobieranie stanów magazynowych w salonach danego towaru. Zawiera następujące pola:

  1. product – pole wymagane
  2. country – maksymalna długość tego pola to 2 znaki
  3. city – maksymalna długość tego pola to 50 znaków
  4. pointTypeId – pole typu int
 

ComparisonToolAdd

Akcja odpowiadająca za dodanie produktu do porównania z innym produktem. Akcja posiada jedno pole productId – pole wymagane, typu int.

 

ComparisonToolDelete

Akcja odpowiada za usunięcie przedmiotu z porównania. Akcja posiada jedno pole productId – pole wymagane, typu int.

 

NotifyAboutProductAvailability

Akcja odpowiadająca za złożenie zapytania odnośnie poinformowania użytkownika o ponownej dostępności towaru. Zawiera następujące pola:

  1. productId – pole wymagane, typu int
  2. name – pole wymagane, maksymalna długość tego pola to 50 znaków
  3. email – pole wymagane,wyrażenie regularne, maksymalna długość tego pola to 192 znaki
  4. phoneNo – maksymalna długość tego pola wynosi 20 znakow
 

ReviewAdd

Akcja odpowiadająca za dodanie opinii na temat produktu. Zawiera następujące pola:

  1. rating – pole wymagane, maksymalna długość od 1 do 5 znaków (długość pola to ocena), typ byte
  2. comment – pole wymagane, maksymalna długość tego pola to 4000 znaków
  3. author – pole wymagane, maksymalna długość tego pola to 50 znaków
  4. productId – pole wymagane, typ int
  5. orderHash – pole typu string
 

WishListAdd

Akcja odpowiedzialna za dodanie produktu do listy życzeń. Zawiera następujące pola:

  1. productId – pole wymagane, typ int
  2. quantity  – pole które przyjmuje wartości w zakresie 1 – 99999, typ decimal
  3. note – maksymalna długość tego pola wynosi 500 znaków
 

WishListDelete

Akcja odpowiadająca za usuwanie przedmiotu z listy życzeń.
Zawiera jedno pole productId – pole to może przyjąć wartość int lub pozostać puste.

 

WishListUpdate

Akcja odpowiada za ustawienie/zmianę daty na liście życzeń. Zawiera następujące pola:

  1. productId – pole typu int
  2. note – maksymalna długość tego pola to 500 znaków
  3. notify – pole to przyjmuje wartość bool (true/false)
  4. notifyDate – pole typu string, wyrażenie regularne (data)
 

Koszyk

Akcja ta odpowiada za działanie związane z koszykiem, np. dodaniem produktu do koszyka.

Add

Odpowiada za dodanie produktów do koszyka. Akcja zawiera następujące pola:

  1. productId – pole wymagane, typu int
  2. quantity- pole może przyjąć wartość w zakresie 0.01 – 99999, typ decimal
  3. unitId – pole typu int – pole może przyjąć wartość int lub pozostać pusta
  4. attributeId – przyjmuje wartość int[] – dane pole może zostać przekazane wielokrotnie w ramach jednej akcji, wartość int
  5. attributeEditable – pole typu string[] – dane pole może zostać przekazane wielokrotnie w ramach jednej akcji
  6. supplyId – pole może zawierać typ int lub pozostać puste
 

AttributesSet

Akcja odpowiada za ustawianie atrybutów na koszyku. Zawiera następujące pola:

  1. no – pole to może przyjąć wartość int lub pozostać puste
  2. attribute – pole typu string[] – dane pole może zostać przekazane wielokrotnie w ramach jednej akcji, maksymalna długość to 1000 znaków.
 

Change

Akcja odpowiada za zmianę koszyka. Zawiera jedno pole – Id – jest to pole obowiązkowe, typu int.

 

Delete

Akcja ta umożliwia usunięcie wszystkich produktów z koszyka.

 

ExternalAdd

Akcja dla konfiguratora produktów. Dodaje do koszyka zawartość zwróconą z sync. Zawiera następujące pola:

  1. id – pole wymagane , maksymalna długość znaków to 40
  2. type – pole typu int
ImportCSV

Akcja odpowiada za importowanie koszyka z pliku. Zawiera następujące pola:

  1. file – pole wczytujące pliki
  2. separator – pole to może pozostać puste lub przyjąć typ char
  3. decimalSeparator – pole to może pozostać puste lub przyjąć typ char
 

NameSet

Akcja odpowiada za ustawienie nazwy wybranego koszyka. Zawiera następujące pola:

  1. id – pole wymagane, typu int
  2. name – maksymalna długość znaków dla tego pola to 30
 

PositionDelete

Odpowiada za usuwanie danej pozycji z koszyka.Akcja następujące pola:

  1. no – pole obowiązkowe, typu int.
  2. position – pole typu boolean
 

QuantityChange
Akcja powoduje zmianę ilości przedmiotu w koszyku.
Posiada następujące pola:

  1. quantity – pole wymagane, przyjmuje wartość od 0.01 do 99999. Typ pola to decimal.
  2. no – pole wymagane, typu int
 

Recalculate

Odpowiada za ponowne przeliczenie koszyka.

 

SetAdd

Akcja obsługuje dodawanie zestawu produktów. Posiada następujące pola:

  1. productId – wymagane, typ pola int
  2. setId – wymagane, typ pola int
  3. quantity – typ pola int, przyjmuje wartości w zakresie 1-99
  4. attributeId – dane pole może zostać przekazane wielokrotnie w ramach jednej akcji, typ int[]
  5. supplyId – dane pole może zostać przekazane wielokrotnie w ramach jednej akcji, typ int[]
 

Kontakt

Akcja ta odpowiada za kontakt, np. w celu zapytania o dany produkt.

AskAboutProduct

Akcja pozwalająca na złożenie zapytania o produkt. Pola:

  1. productId – pole wymagane, typu int
  2. email – pole obowiązkowe, wyrażenie regularne, maksymalna długość pola to 192 znaki
  3. phoneNo – maksymalna długość tego pola to 20 znaków
  4. name – pole obowiązkowe, maksymalna długość tego pola to 50 znaków
  5. message – pole obowiązkowe, maksymalna długość tego pola wynosi 500 znaków
  6. copy – pole typu bool (true/false)
 

Send

Akcja odpowiadająca za wysłanie zawartości formularza kontaktowego. Zawiera następujące pola:

  1. email – pole wymagane,wyrażenie regularne, maksymalna długość tego pola to 192 znaki
  2. name – maksymalna długość tego pola wynosi 50 znaków
  3. phoneNo – maksymalna długość tego pola wynosi 20 znaków
  4. subject – pole wymagane, maksymalna długość tego pola wynosi 50 znaków
  5. message – pole wymagane, maksymalna długość tego pola wynosi 500 znaków
  6. copy – pole typu bool (true/false)
  7. contactId – pole typu int
  8. files – pole dla wczytywanych plików
Akcja Contact/Send może przyjmować pola zdefiniowane przez użytkownika.
Nazwa pola musi zawierać przedrostek macro_ np. macro_Pole1 , a typ pola powinie być text.
Przykład modyfikacji w szablonie Bursztyn:
Aby pola użytkownika były widoczne w mailu ze strony kontakt należy należy dodać w ich treści zdefiniowane pola.
Przykład dodania takich pól poniżej:
 

TellFriendAboutProduct

Akcja odpowiedzialna za wysłanie powiadomienia odnośnie danego produktu do innej osoby poprzez e-mail. Akcja zawiera:

  1. productId – pole wymagane, typ int
  2. email – pole wymagane, wyrażenie regularne, maksymalna długość tego pola to 192 znaki
  3. name – maksymalna długość tego pola to 50 znaków
  4. message – pole wymagane, maksymalna długość to 500 znaków
  5. copy – typ bool (true/false)
  6. friendEmail – pole wymagane, wyrażenie regularne, maksymalna długość to 192 znaki
  7. friendName – maksymalna długość tego pola to 50 znaków
 

Edycja zamówienia

Akcje te związane są z edycją zamówienia

Accept

Akcja odpowiedzialna za wysłanie żądania o zastosowanie wszystkich zmian. Akcja zawiera jedno pole – orderId – obowiązkowe pole typu int.