WebAPI udostępnia dedykowane operacje do mechanizmu OSS opisane poniżej. Korzystają one z ustawień definiowanych do danego sklepu natomiast sklep podczas wykowywana operacji jest w WebAPI definiowany na podstawie parametru deviceName podanego przy otwieraniu danej sesji. Opis metody otwierania sesji w WebAPI dostępny w linku poniżej.
ISessionController.OpenNewSession Method >>
Mapowanie towarów
Mapowanie towarów umożliwia powiazanie towarów ze sklepu internetowego z towarami w kartotece Symfonia ERP Handel/Symfonia Handel. Powiązanie obowiązuje w obrębie danego sklepu oraz kraju, który został wskazany podczas tworzenia powiązania.
Towar ze sklepu internetowego może być powiązany tylko z jednym towarem w Handlu ale towar z Handlu może mieć wiele powiązań do towarów ze sklepu internetowego. Ograniczenie to obowiązuje w obrębie jednego sklepu oraz jednego kraju, który został wskazany podczas tworzenia powiązania.
Oznacza to, że towar X ze sklepu internetowego może być powiązany z towarem A z Handlu dla kraju AA oraz z towarem B dla kraju BB.
Oznacza to również że towar z Handlu A może mieć wiele powiązań z towarami ze sklepu internetowego np. towar A w kraju AA, może mieć powiązanie do towarów ze sklepu internetowego X, Y, Z itp.
Poniżej przykład tworzenia powiązania pomiędzy towarem o identyfikatorze 65586 z Handlu, a towarem o identyfikatorze X ze sklepu internetowego dla kraju o identyfikatorze 47.
{
"ErpProductId": 65586,
"ShopProductId": "X",
"CountryId": 47
}
Powiązania można utworzyć tylko dla sklepów, krajów i towarów działających w OSS. Kraj w konfiguracji OSS musi mieć zaznaczoną opcje Obsługiwany oraz towar dla tego kraju musi być oznaczony jako Udostępniony w danym kraju.
Dzięki utworzonym powiązaniom na pozycjach dokumentów możliwe jest podanie towaru ze sklepu internetowego. Na podstawie utworzonych powiązań odnaleziony zostanie odpowiedni towar z Handlu.
Tworzenie kontrahenta
Tworzenie kontrahenta przez mechanizm OSS, w odróżnieniu od standardowego mechanizmu w WebAPI, umożliwia zapisanie kontrahenta, który w nazwie i/lub adresie posiada znaki inne niż polskie i łacińskie.
Należy pamiętać, że możliwość zapisania znaków innych niż polskie nie dotyczy kodu kontrahenta.
Nazwa kontrahenta zapisywania jest w wymiarze analitycznym OssWebApiContractorName, który został utworzony podczas instalowania modułu w Handlu.
Tworzenie dokumentów
Mechanizm OSS umożliwia tworzenie dokumentów zamówienia obcego, dokumentów sprzedaży oraz powiązanych do nich dokumentów magazynowych oraz sprzedaży na podstawie ustawień danego sklepu oraz ustawień towarów.
Typ dokumentu pobierany jest na podstawie ustawień w konfiguracji OSS dla sklepu oraz podanego podczas tworzenia dokumentu kraju. Określenie czy dokument dotyczy sprzedaży krajowej, w UE czy poza UE następuje przy pomocy symbolu kraju oraz oznaczenia UE w słowniku Kraje(Ustawienia>Słowniki> Kraje):
•Dokument dla sprzedaży krajowej – podany kraj ma symbol PL;
•Dokument dla sprzedaży w UE – podany kraj ma w słowniku zaznaczoną opcje UE;
•Dokument dla sprzedaży poza UE – podany kraj w słowniku nie ma zaznaczonej opcji UE.
Tworzenie dokumentu przez mechanizm OSS zapisuje nazwę oraz adres odbiorcy i nabywcy w polach własnych dokumentów:
•Adres odbiorcy – zapisywany w polu własnym dokumentu OssWebApiRecipientAddress;
•Nazwa odbiorcy – zapisywana w polu własnym dokumentu OssWebApiRecipientName;
•Adres nabywcy – zapisywany w polu własnym dokumentu OssWebApiBuyerAddress;
•Nazwa nabywcy – zapisywana w polu własnym dokumentu OssWebApiBuyerName.
Nazwy odbiorcy i nabywcy dla kontrahentów kartotekowych przepisywane są z wymiaru kontrahenta OssWebApiContractorName. W przypadku gdy wymiar ten nie jest uzupełniony wówczas pobierana jest jego nazwa. Dla kontrahentów incydentalnych nazwy i adresy pobierane są z danych przesłanych podczas tworzenia dokumentu.
Podany podczas tworzenia dokumentu kraj zapisywany jest w polu własnym OssWebApiCountry . Nazwa sklepu pobierana jest na podstawie parametru deviceName otwartej sesji wykorzystanej do utworzenia dokumentu i zapisywana jest w polu własnym OssWebApiShop.
W polu własnym OssWebApiOrderId zapisywany jest identyfikator zamówienia ze sklepu, który nie jest wymagany podczas tworzenia dokumentu.
Dodanie towaru do dokumentu możliwe jest poprzez podanie jego identyfikatora z Handlu lub sklepu internetowego. W przypadku podania identyfikatora towaru ze sklepu internetowego odpowiedni towar w Handlu zostanie pobrany na podstawie utworzonego wcześniej powiązania. Jeśli podane zostaną oba identyfikatory towaru, wówczas towar w pierwszej kolejności pobierany jest na podstawie identyfikatora towaru z Handlu.
Na podstawie ustawień towarów w konfiguracji OSS pobierane są stawki VAT towarów w danym kraju.
Dodatkowo tworzenie dokumentów przez mechanizm OSS, w odróżnieniu od standardowego mechanizmu w WebAPI wymaga opisu pozycji dokumentu. Operacja ta zapisuje opis pozycji w polu własnym pozycji OSSWebApiPosDesc.
Należy pamiętać, że w mechanizmie OSS towary o typie zestaw nie są obsługiwane.
Poniżej przykład utworzenia dokumentu zamówienia dla sprzedaży krajowej z pozycją, gdzie towar wskazany jest za pomocą identyfikatora sklepu internetowego.
{
"PaymentRegistry": {
"Id": 130
},
"PaymentFormId": 65616,
"SalePriceType": "4",
"Note": "notatka",
"Description": "opis",
"ReceivedBy": "",
"PriceKind": 1,
"Marker": "79",
"ReservationType": 0,
"Positions": [
{
"ShopProductId": "baton bakalie",
"Description": "bakalie",
"Quantity": 5,
"Value": 29.99
}
],
"Buyer": {
"Id": 37
},
"Recipient": {
"Id": 37
},
"Country": "PL",
"ShopOrderId": "zamowienie_1"
}
Mechanizm OSS umożliwia tworzenie powiązanych dokumentów. Dotyczy to tylko dokumentów, które zostały wystawione przez ten sam sklep.
Należy pamiętać, że typy dokumentów podane w ustawieniach sklepu konfiguracji OSS dotyczą tworzenia nowych dokumentów. Podczas tworzenia dokumentów z nimi powiązanych wybierany będzie skojarzony typ dokumentu ustawiony w systemie Symfonia ERP Handel/Symfonia Handel w folderze Typy dokumentów.
Wydruki
Operacja generuje wydruk w formacie PDF na podstawie ustawień OSS. Nazwa sklepu do ustalenia szablonu wydruku pobierana jest na podstawie parametru deviceName podanego podczas otwieraniu danej sesji WebAPI. Kraj pobierany jest z pola własnego dokumentu (OssWebApiCountry).
Na podstawie pobranego sklepu i kraju generowany jest wydruk według szablonu ustawionego dla danego charakteru dokumentu w konfiguracji OSS. Określenie czy wydruk dotyczy sprzedaży krajowej, w UE czy poza UE następuje przy pomocy symbolu kraju oraz oznaczenia UE w słowniku Kraje(Ustawienia>Słowniki> Kraje):
•Wydruk dla sprzedaży krajowej – pobrany kraj ma symbol PL;
•Wydruk dla sprzedaży w UE – pobrany kraj ma w słowniku zaznaczoną opcje UE;
•Wydruk dla sprzedaży poza UE – pobrany kraj w słowniku nie ma zaznaczonej opcji UE.
Jeśli dla danego wydruku w konfiguracji OSS ustawiony jest Standardowy wydruk WebApi wówczas poniższe elementy zastępowane są wartościami z pól własnych dokumentu:
•Adres odbiorcy – pobierany z pola własnego dokumentu OssWebApiRecipientAddress;
•Nazwa odbiorcy – pobierana z pola własnego dokumentu OssWebApiRecipientName;
•Adres nabywcy – pobierany z pola własnego dokumentu OssWebApiBuyerAddress;
•Nazwa nabywcy – pobierana z pola własnego dokumentu OssWebApiBuyerName;
•Opis pozycji – pobierany z pola własnego pozycji dokumentu OSSWebApiPosDesc.
