Dokumentacja techniczna API Sprzedającego

Transkrypt

1 Dokumentacja techniczna API Sprzedającego DHL Parcel All You Need Stan z dnia: ; v 4.1

2 Spis treści 1 Wstęp Informacje techniczne Wymagany dostęp Informacja zwrotna i wsparcie Dokumenty i przykłady do pobrania Podstawy merytoryczne i przegląd Pasażu Handlowego Nagłówki XML Wywołanie odpowiedzi merytoryczny Definiowanie Oferty produktów w Pasażu Handlowym merytoryczny Definiowanie Kategorie produktów sklepu Sprzedającego merytoryczny Definiowanie Oferty produktów Sprzedającego merytoryczny Definiowanie Warianty produktu Definiowanie grupy wariantów Definiowanie konfiguracji wariantów Przykłady konfiguracji wariantów różnych asortymentów Market budowlany Książki Sprzęt elektroniczny powszechnego użytku Filmy Gry Sprzęt AGD Artykuły spożywcze Soczewki kontaktowe Przegląd konfiguracji wariantów internetowy Pasaż handlowy Powszechnie stosowane konfiguracje wariantów Konfiguracje wariantów dla asortymentów Książka, Film i Gry Konfiguracje wariantów soczewek kontaktowych...32

3 10.4 Konfiguracje wariantów dla asortymentu Moda Kategorie do pobrania merytoryczny Definiowanie Oferty produktów do pobrania merytoryczny Definiowanie Wywołanie wskaźników merytoryczny Definiowanie Usuwanie merytoryczny Definiowanie Podstawy merytoryczne i przegląd interfejsów procesu zamówienia Zamówienie merytoryczny Definiowanie Przesyłka towarów merytoryczny Definiowanie Śledzenie przesyłki merytoryczny Definiowanie Anulowanie zamówienia merytoryczny Definiowanie Zwroty merytoryczny Definiowanie Zapytanie o najniższą cenę merytoryczny Definiowanie Wywoływanie danych produktu merytoryczny Definiowanie Zapytanie o dane Sprzedającego...65

4 23.1 merytoryczny Definiowanie Kontakt...67 Załącznik A...68 Załącznik B...69 Załącznik C...70 Załącznik D...71 Załącznik E...72

5 1 Wstęp Witamy w serwisie internetowym All You Need służącym do aktualizacji danych produktów i realizacji zamówień na internetowym Pasażu Handlowym. Niniejszy dokument ma być pomocą dla Sprzedających podczas oferowania produktów do sprzedaży w Pasażu Handlowym lub przy projektowaniu własnego sklepu on-line oraz przy realizacji zamówień. Zawiera merytoryczny i techniczny opis interfejsu i jest opracowany jako dokument referencyjny dla programistów pracujących nad rozwojem oprogramowania. W dokumencie wyjaśniono podstawy i powiązania, jak również opisano podłączenie techniczne. Przez ten interfejs można oferować produkty w Pasażu Handlowym, jak również ustawiać je we własnym sklepie internetowym, można je aktualizować lub wyłączać. Tym samym każdy Sprzedający może rozszerzać swoją ofertę produktową i utrzymywać ją w aktualnym stanie, jak również przeprowadzić kategoryzację produktów. Rozdział 1 zawiera wprowadzenie do interfejsu. Rozdział 2 daje ogólny przegląd techniczny Pasażu Handlowego. Rozdział 3 pokazuje budowę nagłówków XML. W Rozdziale 4 opisano możliwość wywołania odpowiedzi za pomocą identyfikatora żądania "RequestID". W Rozdziale 5 opisano jak produkty z katalogu DHL można oferować w Pasażu Handlowym. Dla Sprzedających, którzy chcą oferować własne produkty w Pasażu Handlowym i w swoim sklepie - przeznaczony jest Rozdział 6, który opisuje, jak tworzyć niezbędne do tego celu kategorie produktów. Wyczerpująco - definicję produktu oraz ustawianie produktów objaśniono w Rozdziale 7. Do tego celu są także niezbędne dane z Rozdziału 4 i dodatkowo z Rozdział 8 opisującego, jak tworzyć warianty do tych produktów. W Rozdziale 9 znajdziesz przykłady, jak można wykorzystywać konfiguracje wariantów. Następnie w Rozdziale 10 wymienione są wszystkie konfiguracje. Rozdział 11 zawiera opis Pobierania kategorii produktów. W Rozdziale 12 opisano Pobieranie ofert produktowych. W Rozdziale 13 opisano, jak wysłane na serwer produkty i kategorie sklepów można usunąć. Przez ten interfejs można wywoływać zamówienia i realizować je. Należy przy tym zwrócić uwagę na to, że zamówienia nie są od razu dostępne, chociaż zostały wysłane przez Klienta. To może się zdarzyć, jeżeli Klienci płacą z góry lub zamówienie nie zostało jeszcze przetworzone na internetowy Pasaż handlowy. Krótkie wprowadzenie do procesów realizacji zamówienia otrzymasz w Rozdziale 14. Rozdział 15 zawiera opis dotyczący żądania "Request", za pomocą którego można wywoływać zamówienia i opisuje treści odpowiedzi "Response" z podstawowymi danymi do zamówienia. W Rozdziale 16 opisano, jak zamówienia można oznaczać jako wysłane do Klienta. Zależnie od tego, kiedy jest dostępny nr śledzenia przesyłki, może on być przesyłany bezpośrednio ze zgłoszeniem przesyłki lub później. Rozdział 17 opisuje tę drugą możliwość, późniejszego przekazania nr śledzenia przesyłki. Jeżeli jakiegoś produktu nie ma na stanie, wtedy Sprzedający może anulować całe zamówienie lub jedną pozycję zamówienia, którą to możliwość opisuje Rozdział 18. Jeżeli Klient odsyła towar z powrotem do Sprzedającego, musi to zostać zgłoszone do internetowy Pasaż Handlowy, aby można było uruchomić księgowanie powrotne. W Rozdziale 19 opisano budowę żądania dotyczącego zwrotu. W Rozdziale 20 dowiesz się, jak można wysłać zapytanie o najlepszą cenę dla produktu, aby

6 polepszyć swoją sytuację w zakresie konkurencyjności. W Rozdziale 21 opisano, jak można wywoływać podstawowe dane produktów. W Rozdziale 22 wyjaśnia się, jak możesz wywołać dane Sprzedającego. W Rozdziale 23 zostaną wyjaśnione noty uznaniowe przez interfejs. 1.1 Informacje techniczne Serwis internetowy All You Need oferuje dwa tryby przetwarzania danych, które różnią się odesłaniem odpowiedzi. W pierwszym trybie pracy żądanie jest przetwarzane natychmiast. W tym czasie musi być utrzymane połączenie HTTP. Na końcu otrzymujesz wynik przetworzenia danych w odpowiedzi. Ten tryb jest przede wszystkim przeznaczony do realizacji zamówień.

7 W drugim trybie po przesłaniu żądania otrzymasz w odpowiedzi nr identyfikacyjny ID żądania "RequestId". Twoje żądania zostanie następnie ustawione w kolejkę oczekujących i potem zostanie przetworzone. W tym czasie nie jest konieczne połączenie HTTP. Status realizacji i odpowiedź możesz wywołać przez podanie ID żądania "RequestId". Ten tryb jest przeznaczony do przetwarzania dużych do bardzo dużych zbiorów danych. Poniższe tabele zawierają przegląd funkcji i możliwy trybu pracy. uploadrequest Funkcja Tryb pracy Deletions usuwanie kategorii lub produktów tryb asynchroniczny Categories tworzenie kategorii tryb asynchroniczny variantgroups tworzenie grup wariantów tryb asynchroniczny Descriptions tworzenie produktów tryb asynchroniczny Offers tworzenie ofert tryb asynchroniczny InternationalPrices tworzenie międzynarodowych ofert tryb asynchroniczny downloadrequest catalogstructure pobranie struktury katalogu tryb synchroniczny lub asynchroniczny getproductoffers pobranie wszystkich ofert produktowych tryb asynchroniczny variantconfigurations pobranie wszystkich konfiguracji wariantów queryrequest tryb synchroniczny lub asynchroniczny orders wywołanie zamówień tryb synchroniczny lub

8 uploadrequest Funkcja Tryb pracy asynchroniczny creditmemos wywołanie wydanych not uznaniowych tryb synchroniczny lub asynchroniczny notificationrequest consignments zgłaszanie przesyłek towarowych tryb synchroniczny lub asynchroniczny trackingnumbers przesyłanie nr śledzenia przesyłki tryb synchroniczny lub asynchroniczny cancellations zgłaszanie anulowania (zamówienia) tryb synchroniczny lub asynchroniczny returns zgłaszanie zwrotów tryb synchroniczny lub asynchroniczny creditmemo tworzenie noty uznaniowej tryb synchroniczny lub asynchroniczny datarequest bestpricerequest wywołanie najlepszej ceny dla produktu tryb asynchroniczny productdatarequest wywołanie danych produktu tryb asynchroniczny getmerchantdata wywołanie danych Sprzedającego tryb asynchroniczny getquota wywołanie dostępnych ilości tryb synchroniczny 1.2 Wymagany dostęp Aby korzystać z interfejsu musisz potwierdzić swoją tożsamość wobec All You Need. Do tego celu potrzebne są: Username (Nazwa użytkownika) Password (Hasło) Te dane otrzymasz automatycznie pocztą elektroniczną natychmiast po odblokowaniu Twojego konta Sprzedającego. Jeżeli jesteś już Sprzedającym na All You Need, można już wykorzystać swoje dotychczasowe dane do logowania. Żądanie HTTP URL: (asynchroniczny interfejs - patrz Rozdział 3) URL: Metoda: HTTP-POST

9 1.3 Informacja zwrotna i wsparcie Jeżeli potrzebujesz pomocy, chcesz przesłać informację zwrotną lub odpowiedz w jakiejkolwiek innej sprawie możesz skontaktować się z nami w następujący sposób: Osoba kontaktowa z działu sprzedaży Osoba kontaktowa z działu wsparcia (eklep@ayn.pl) 1.4 Dokumenty i przykłady do pobrania Do poszczególnych rozdziałów istnieją przykładowe pliki z możliwymi odpowiedziami. Wszystkie przykładowe pliki znajdują się w naszej strefie do pobrania. W poszczególnych plikach zawarte są dodatkowe komentarze, które ułatwią Ci pracę z naszym interfejsem. W załączniku D znajdziesz przegląd przykładowych plików.

10 2 Podstawy merytoryczne i przegląd Pasażu Handlowego All You Need jest podzielony na dwie płaszczyzny. Centralną z nich umożliwia zakupy online, zwany dalej Pasażem Handlowym. Druga z nich to część dla Sprzedających i ich sklepy. Pasaż Handlowy zawiera obszerny katalog produktów, który udostępnia DHL. Dla każdego produktu istnieje odpowiedni krótki i długi opis, jedno lub kilka zdjęć i atrybuty. Pasaż Handlowy ma strukturę drzewa kategorii, które podzielone są na cztery główne zakresy tematyczne. Każdy zarejestrowany Sprzedający może pobrać te kategorie. Produkt będzie widoczny w danej kategorii jeżeli chociaż jeden Sprzedający oferuje go w swoim sklepie. Każdy Sprzedający może oferować w Pasażu Handlowym dowolnie liczbę produktów, do tego celu potrzebuje jedynie zamieścić swoje specyficzne informacje o tych produktach. Minimalne informacje to cena, dostępność (liczba sztuk) i specyficzny dla danego Sprzedającego nr identyfikacyjny - IDproduktu - wszystkie pozostałe informacje są opcjonalne. Można pobrać przegląd wszystkich produktów oferowanych przez Sprzedającego. Wszystkie produkty, które oferuje Sprzedający, są także wyświetlane w jego własnym sklepie. We własnym sklepie istnieje jeszcze dodatkowo możliwość zdefiniowania własnej struktury katalogu i następnie odpowiedniego przyporządkowania produktów. Ponadto Sprzedający może tworzyć produkty z własnymi opisami, zdjęciami i oferować je w Pasażu Handlowym oraz w swoim własnym sklepie.

11 3 Nagłówki XML Do każdego żądania są wymagane informacje nagłówka do identyfikacji Sprzedającego. Te pola są poniżej zdefiniowane i muszą być podane w przypadku każdego żądania wysłania danych. Nazwa Atrybut Typ Długość Sprzedający- Użytkownik login string 100 tak Pole Hasło password string 100 tak Hasło Sprzedającego-Użytkownika Sprzedający-Użytkownik (adres umieszczony na Twoim koncie) Język language string 100 nie Język, jeżeli nie wypełniono, wysyłany jest "pl" Multiplier multiplierid string 100 nie Pole to nie musi być wykorzystywane przez poszczególnych Sprzedających lub może być ustawione jako UNKNOWN. Jeżeli oferując system Multi-Shop opracowujesz podłączenie do Twojego systemu, proszę zwrócić się do działu wsparcia (Support), aby otrzymać własny nr identyfikacyjny - multiplierid. Możliwe identyfikatory typu multiplierid znajdują się w załączniku C.

12 4 Wywołanie odpowiedzi 4.1 merytoryczny Jeżeli żądanie zostało wysłane do asynchronicznego interfejsu, wtedy to żądanie otrzymuje numer identyfikacyjny "ReqestId". Za pomocą tego nr identyfikacyjnego można wywołać stan realizacji i wynik przetwarzania danych. 4.2 Definiowanie Poniższe dane są niezbędne do pobrania odpowiedzi. Pola, które są bezwzględnie wymagane, mają w kolumnie "Pole " "tak". Pola, które nie są polami obowiązkowymi i nie są wysyłane, nie są ustawiane. Tabela zawiera atrybuty, które korespondują z opisem technicznym w data.xsd i każdorazowo krótki opis zawartości. Nazwa Atrybut Typ Długość RequestId requestid string 100 tak Status lub Odpowiedź onlystatus boolean Pole nie Unikalny nr identyfikacyjny ID, który identyfikuje żądanie Wybór elementów odpowiedzi: true (prawda) odsyłany jest z powrotem tylko stan realizacji żądania false (fałsz) odpowiedź jest odsyłana z powrotem, jeżeli już jest, w przeciwnym przypadku - stan Jeżeli nic nie jest przekazywane, wtedy standardowo przekazywany jest tylko stan.

13 5 Oferty produktów w Pasażu Handlowym 5.1 merytoryczny All You Need udostępnia obszerny katalog produktów. Produkty są identyfikowane za pomocą EAN (European Article Number), ISBN13 (Międzynarodowy Standard Numerów Księgowych) etc.. Każdy zarejestrowany Sprzedający jest automatycznie uczestnikiem Pasażu Handlowego i może oferować dowolne produkty z tego katalogu. Do tego potrzeba tylko kilku informacji, ponieważ dla wspomnianych produktów istnieją już dokładne opisy. Sprzedający musi dla tych produktów jedynie podać EAN lub nr identyfikacyjny Pasaż Handlowego jako nr referencyjny dla danego produktu, cenę i dostępną ilość sztuk, jak również jednoznaczny wewnętrzny kod Sprzedającego (wewnętrzny numer produktu Sprzedającego). Pozostałe informacje jak np. data początkowa są opcjonalne. Dzięki temu każdy Sprzedający może tylko za pomocą tych minimalnych informacji oferować produkty z szerokiej oferty Pasażu Handlowego. Po bezbłędnym wysłaniu na serwer wymaganych danych przez Sprzedającego są one dostępne w Pasażu Handlowym. Jeżeli rekordy danych poszczególnych produktów są niepełne lub błędne, wtedy po ich wysłaniu zostanie przesłane zgłoszenie zwrotne o błędzie w "uploadresponse". Sprzedający może skorygować błędne lub nie wysłane produkty i je ponownie wysłać. Przy tym wystarczy ponownie zamieścić tylko te pierwotnie błędne dane, nie jest zaś konieczne ponowne przesyłanie wszystkich rekordów danych. Prawidłowo wysłane produkty pozostają aktywne do sprzedaży w Pasażu Handlowym do momentu spełnienia się jednego z poniższych warunków: podana liczba sztuk produktu została sprzedana lub jest zarezerwowana dla danej oferty produktowej Sprzedający podał datę zakończenia i ten dzień właśnie nadszedł sklep Sprzedającego jest offline lub zablokowany konto Sprzedającego nie jest już aktywne lub złożono wypowiedzenie produkt został zablokowany 5.2 Definiowanie Dla każdego pojedynczego produktu, który ma być oferowany, możliwe są poniższe dane. Pola, które są bezwzględnie wymagane, mają w kolumnie "Pole " "tak". Pola, które nie są polami obowiązkowymi i nie są wysyłane, nie są ustawiane lub są wypełniane wartością domyślną (patrz kolumna ). Tabela zawiera atrybuty, które korespondują z opisem technicznym w common.xsd i product.xsd i każdorazowo krótki opis zawartości:

14 Nazwa Atrybut Typ Długość Pole ID produktu Sprzedającego Pasaż handlowy ID produktu productid string 100 tak Wewnętrzny i unikalny numer artykułu Sprzedającego meinpaketid string 100 nie Unikalny numer artykułu internetowy Pasaż handlowy European article number ean string 13 nie European Article Number, EAN produktu; w przypadku książek ISBN-13 Producent manufacturername string 100 nie Nazwa producenta* Numer artykułu producenta Cena sprzedaży manufacturerpn string 100 nie Numer artykułu producenta price double tak Cena jednostkowa unitprice double nie Cena na każdą jednostkę Jednostka Dostępność Data początkowa Data zakończenia unit string 100 nie availability integer tak startdate datetime nie enddate datetime nie Cena jednostkowa zawierająca ustawowy podatek VAT z maksymalnie dwoma miejscami po przecinku i kropką jako separatorem dziesiętnych. Jednostka ilości produktu: Sztuka = per_piece Kilogram = per_1kg Litr = per_1l Metr sześcienny = per_1m3 Metr = per_1m Metr kwadratowy = per_1m2 Gram = per_100g Mililitr = per_100ml Dostępna liczba sztuk tego produktu. Liczba sztuk przy każdej sprzedaży jest automatycznie obniżana. Jeżeli liczba sztuk wynosi 0 wtedy produkt jest wyświetlany jako wyprzedany. Data, od kiedy produkt jest dostępny do zamawiania przez Klienta, tzn. jest widoczny w Pasażu Handlowym u tego Sprzedającego. Data musi być wysłana w następującym formacie: YYYY-MM-DDThh:mm:ss ** Data, od której produkt nie jest już dostępny, tzn. nie jest ani widoczny, ani nie można go wybrać do zamówienia. Data musi być wysłana w

15 Nazwa Atrybut Typ Długość Pole Termin dostawy Kategoria w sklepie Sprzedającego deliverytime integer nie następującym formacie: YYYY-MM-DDThh:mm:ss ** Czas dostawy produktu do klienta w dniach, od 1 do 29 dni. Jeżeli nie jest podany termin dostawy, wtedy wstawia się domyślnie jeden dzień. shopcategory categoryref 100 nie Kategoria produktu we własnym sklepie Sprzedającego*** Grupa wariantów variantgroupcode string 100 nie Kod grupy wariantów Fixed Product Kod atrybutu useasfixedproduct boolean nie code string 100 tak Fixed-Product dla wyników wyszukiwania; Jeżeli wysyłany jest dla więcej niż jednego produktu, to ostatni produkt jest FixedProduct ; standardem jest "false" Unikalny ID atrybutu. Ten kod identyfikuje dla każdego Sprzedającego każdy atrybut. Nazwa atrybutu name string 100 nie Nazwa cechy produktu jak wymiary, kolory etc. Wartość atrybutu value string 100 nie Wartość atrybutu Jednostka atrybutu unit string 100 nie Jednostka wartości atrybutu Koszty przesyłki deliverycost double nie Informacja na temat specyficznych kosztów przesyłki tego produktu Stałe koszty przesyłki fixedcost boolean nie Rodzaj dostawy dispatchtype String nie * Jeżeli chcesz podać numer artykułu producenta, wtedy wymagane jest także podanie nazwy producenta. ** Format datetime ma następującą specyfikację "YYYY-MM-DDThh:mm:ss" przy czym: - YYYY Rok - MM Miesiąc - DD Dzień Informacja, czy koszty przesyłki tego produktu zawsze są doliczane w całości, niezależnie od stopniowania etc.. Wymagane dispatchtype BULK_GOODS lub FORWARDING_AGENCY Rodzaj dostawy produktu. Możliwe są poniższe wartości: BULK_GOODS ładunek przestrzenny FORWARDING_AGENCY towar spedycyjny**** BOOK_RATE Przesyłka książek CONSIGNMENT_OF_GOODS Przesyłka towarowa

16 - Znak T, że od tego punktu zaczyna się format czasu - hh Godziny - mm Minuty - ss Sekundy. *** Kategorie sklepu muszą zostać utworzone przed rozpoczęciem użytkowania. (Patrz Rozdział 4) **** w przypadku towaru spedycyjnego jest zapytanie o numer klienta i jest on Ci później pokazany, aby umożliwić zaplanowanie dostawy

17 6 Kategorie produktów sklepu Sprzedającego 6.1 merytoryczny Sprzedający na All You Need ma własny sklep Sprzedającego. W nim wyświetlane są wszystkie produkty, które Sprzedający oferuje, zarówno produkty Pasażu Handlowego z ofertami Sprzedającego, jak i jego własne produkty. Każdy Sprzedający ma możliwość korzystania z własnych kategorii sklepu. W tym celu musi on najpierw ustalić kategorie dla swoich produktów i te wysłać do sklepu. Następnie można dodać produkty z własnymi opisami i zdjęciami (patrz Rozdział 7). Kategorie sklepu można zbudować hierarchicznie. Kategorie w sklepie Sprzedającego można ponownie usunąć. Jest to jednak możliwe tylko wtedy, gdy w danych kategoriach - ewentualnie podkategoriach - nie znajdują żadne produkty. Jeżeli Sprzedający chce w swoim sklepie korzystać z własnych kategorii, wówczas musi to oznaczyć na swoim sklepie. W tym celu konieczne jest zwrócenie się do działu wsparcia o aktywację. W pozostałych wypadkach przyjmuje się jako podstawę do oferowanych produktów strukturę kategorii Pasażu Handlowego i część tej struktury odpowiednio wypełniona ofertami jest pokazywana w sklepie Sprzedającego. Kategorie sklepu są opcjonalne, mimo to kategoria Pasażu Handlowego pozostaje daną obligatoryjną. 6.2 Definiowanie Poniższe dane są wymagane do tworzenia kategorii. lub model hierarchiczny jest do tego tworzenia opcjonalny, nie konieczny. Tabela zawiera atrybuty, które korespondują z opisem technicznym w common.xsd und product.xsd i każdorazowo krótki opis zawartości: Tworzenie kategorii: Nazwa Atrybut Typ Długość ID kategorii code string 100 tak Nazwa kategorii name string 100 tak Pole Unikalny ID kategorii sklepu: Każda kategoria posiada unikalny kod kategorii, który jednak w sklepie nie jest widoczny. Służy on do identyfikacji kategorii. Nazwa kategorii produktu: Ta nazwa jest wyświetlana w sklepie. Każda kategoria nadrzędna i wszystkie podrzędne kategorie danej nadrzędnej kategorii muszą mieć jednoznaczną nazwę. kategorii shortdescription string 100 nie Krótki opis kategorii Kategoria nadrzędna parent string 100 nie Kategoria nadrzędna: Musi ona zostać utworzona odpowiednio wcześniej, co jest możliwe w tym samym "uploadrequest".

18 7 Oferty produktów Sprzedającego 7.1 merytoryczny Dodatkowo oprócz produktów Pasażu Handlowego każdy Sprzedający może ustawiać w swoim sklepie i na All You Need swoje własne produkty, których nie zawiera katalog DHL. Ewentualnie może on wysłać do swojego sklepu własny opis do istniejących produktów DHL. Aby produkty stały się widoczne, oprócz ich opisów wymagane są oferty, jak opisano w Rozdziale 4. W tym rozdziale nie powtarza się opisu oferty, lecz definiuje tylko dodatkowe pola. Produkty bezpośrednio po wysłaniu danych na serwer nie są dostępne do sprzedaży. Może dojść do pewnego przesunięcia czasowego, ponieważ musi zostać przeprowadzona indeksacja produktów za pomocą wewnętrznej wyszukiwarki. Także tu, analogicznie do Pasażu Handlowego, pojawia się informacja zwrotna, czy produkty zostały wysłane bezbłędnie. Prawidłowo wysłane na serwer dane produktów pozostają aktywne do sprzedaży w sklepie Sprzedającego do momentu spełnienia się jednego z poniższych warunków: podana liczba sztuk produktu została sprzedana lub jest zarezerwowana dla danej oferty produktowej Sprzedający podał datę zakończenia i ten dzień właśnie nadszedł sklep Sprzedającego jest off-line lub zablokowany konto Sprzedającego nie jest już aktywne lub złożono wypowiedzenie produkt został zablokowany Do zmiany lub aktualizacji już wysłanych produktów wymagany jest zawsze pełny opis produktu. Nie można aktualizować pojedynczych pól. Produkty Sprzedającego, których dane zostały wysłane do Pasażu Handlowego, można ponownie usunąć. Jednocześnie zostanie również usunięta oferta Sprzedającego na ten produkt. 7.2 Definiowanie Dla każdego pojedynczego produktu, który ma być oferowany, oprócz Informacji ofertowych w Rozdziale 4 wymagane są poniższe dane. Tabela zawiera atrybuty, które korespondują z opisem technicznym w następnym rozdziale i każdorazowo krótki opis zawartości.

19 Wysyłanie danych produktu Nazwa Atrybut Typ Długość ID produktu Sprzedającego Pasaż handlowy ID produktu European article number Pole productid string 100 tak Wewnętrzny i unikalny numer artykułu Sprzedającego meinpaketid string 100 nie Unikalny numer artykułu internetowy Pasaż handlowy ean string 13 nie European Article Number, EAN produktu; w przypadku książek ISBN-13 Producent manufacturername string 100 nie Nazwa producenta* Numer artykułu producenta manufacturerpn string 100 nie Numer artykułu producenta Nazwa produktu name string 100 tak Nazwa produktu Krótki opis produktu shortdescription string 200 tak Krótki opis produktu*** Długi opis produktu longdescription string 4000 nie Szczegółowy opis produktu*** Zdjęcie image image 512 nie URL do zdjęcia produktu Sprzedającego. Maksymalna wielkość 2 MB Kategoria w Pasażu Handlowym Kategoria w sklepie Sprzedającego marketplacecateg orie string 100 tak Kategoria produktu w Pasażu Handlowym shopcategorie string 100 nie Kategoria produktu we własnym sklepie Sprzedającego** Kod atrybutu code string 100 tak Unikalny ID atrybutu. Ten kod identyfikuje dla każdego Sprzedającego każdy atrybut. Nazwa atrybutu name string 100 nie Nazwa cechy produktu jak wymiary, kolory etc. Wartość atrybutu value string 100 nie Wartość atrybutu Jednostka atrybutu unit string 100 nie Jednostka wartości atrybutu

20 * Jeżeli chcesz podać numer artykułu producenta, wtedy wymagane jest także podanie nazwy producenta. ** W przypadku nr referencyjnego do kategorii sklepu Sprzedającego należy zwrócić uwagę na to, że są one utworzone, patrz Rozdział 6. *** dozwolone Tagi HTML patrz Załącznik B

21 Zasadniczo można usunąć wszystkie opisy produktu i oferty produktu. Jeżeli opisy produktów i oferty produktów odnoszą się do jeszcze nie zakończonego zamówienia (anulowanego lub nadanego jako przesyłka), wtedy nie mogą one zostać skasowane. Dopiero po zakończeniu realizacji zamówienia możliwe jest skasowanie odnośnych opisów produktów i ofert produktów. Proszę zwrócić uwagę na to, że mogą istnieć zamówienia, nawet jeżeli nie pojawiają się one na Twoim koncie. Chodzi tu o zamówienia jeszcze nie przetworzone przez internetowy Pasaż handlowy lub o zamówienia, za które ma być pobrana zapłata z góry.

22 8 Warianty produktu Aby ustawić produkt w różnych wariantach na All You Need, należy przeprowadzić następujące trzy etapy: 1. Identyfikacja konfiguracji wariantów Konfiguracja wariantów określa cechy, którymi różnią się warianty produktu. Pasaż Handlowy udostępnia dla różnych zakresów asortymentów wstępnie zdefiniowane konfiguracje wariantów, aby ujednolicić tworzenie wariantów w Pasażu Handlowym. Definiuje z reguły wartości domyślne atrybutów. Jednakże w określonych przypadkach wartości wariantów nie są podane przez internetowy Pasaż handlowy jako obligatoryjne. I tak, Sprzedający mogą przykładowo określić atrybut "Kolor" po prostu wprowadzeniem opcji bez tekstu. Inne wartości są, zależnie od naszej definicji, albo wartościami tekstowymi albo liczbowymi. Teraz proszę określić, jakie konfiguracje wariantów pasują do Twojego produktu. 2. Definiowanie grupy wariantów Grupa wariantów odzwierciedla wszystkie warianty produktu dostępne w Pasażu Handlowym. Po określeniu w etapie 1, jakie konfiguracje wariantów pasują do Twojego produktu, proszę teraz utworzyć grupę wariantów. Przykład: Chcesz oferować produkt "Koszula Boss z nadrukiem XY" w różnych rozmiarach. W etapie 1 określiłeś w tym celu konfigurację udostępnioną przez internetowy Pasaż handlowy (w przykładzie "Ubranie z USA"). Teraz proszę utworzyć dla produktu odpowiednią grupę wariantów przydzielić jej unikalny kod do własnego użytku (np. "Koszula Boss 001") i nazwę jako opis grupy produktów (np. "Koszula Boss z nadrukiem XY"). Uwaga: Nazwa, którą nadajesz grupie produktów, pojawia się na liście wyników wyszukiwania jako przedstawiciel konkretnych pojedynczych artykułów danej grupy produktów. 3. Wysyłanie wariantów Teraz możesz ustawiać i oferować w Pasażu Handlowym warianty produktu tak jak zwykłe produkty, przy czym tylko grupa wariantów utworzona przez Ciebie w etapie 2 musi mieć odniesienie i muszą zostać podane atrybuty wariantów. Poniższy diagram obrazuje wysyłanie danych wariantów produktu na internetowy Pasaż handlowy jeszcze raz:

23 Grupa wariantów "Koszula Boss z nadrukiem XY" Konfiguracja Atrybut1: Rozmiar Atrybut2: Kolor Warianty produktu S S S M XL XL czarny biały niebieski niebieski zielony czarny 8.1 Definiowanie grupy wariantów Poniższe dane są niezbędne do tworzenia grup wariantów produktu. Tabela zawiera atrybuty, które korespondują z opisem technicznym w następnym rozdziale i każdorazowo krótki opis zawartości. Grupa wariantów Nazwa Atrybut Typ Długość Grupa wariantów code string 100 tak Kod konfiguracji configuration string 100 tak Tytuł grupy title string 4000 nie Pole Unikalna identyfikacja grupy wariantów, np. "Levis501" Unikalny nr referencyjny istniejącej konfiguracji Tytuł grupy, np. "Levis Jeans 501" 8.2 Definiowanie konfiguracji wariantów Poniższe dane są niezbędne do opisu produktu z wariantami. Chodzi tu o opis (analogicznie do Rozdziału 7.2) rozszerzony o grupę wariantów. Tabela zawiera wartości, które korespondują z opisem technicznym w następnym rozdziale i każdorazowo krótki opis zawartości.

24 Nazwa Atrybut Typ Długość ID produktu Sprzedającego Pasaż handlowy ID produktu European article number Pole productid string 100 tak Wewnętrzny i unikalny numer artykułu Sprzedającego meinpaketid string 100 nie Unikalny numer artykułu internetowy Pasaż handlowy ean string 13 nie Producent manufacturername string 100 nie Nazwa producenta* Numer artykułu producenta Grupa wariantów manufacturerpn string 100 nie Numer artykułu producenta variantgroupcode string 100 nie Grupa wariantów Nazwa produktu name string 100 tak Nazwa produktu Krótki opis produktu Długi opis produktu shortdescription string 200 tak Krótki opis produktu longdescription string 4000 nie Szczegółowy opis produktu Zdjęcie image image 512 nie Kategoria w Pasażu Handlowym Kategoria w sklepie Sprzedającego European Article Number, EAN produktu; w przypadku książek ISBN-13 URL do zdjęcia produktu Sprzedającego. Maksymalna wielkość 2 MB marketplacecategorie string 100 tak Kategoria produktu w Pasażu Handlowym shopcategorie string 100 nie Kategoria produktu we własnym sklepie Sprzedającego Kod atrybutu code string 100 tak **Nazwa atrybutu Unikalny ID atrybutu. Ten kod identyfikuje dla każdego Sprzedającego każdy atrybut name string 100 nie Określone cechy produktu jak wymiary, kolory itp.

25 Nazwa Atrybut Typ Długość Pole **Wartość atrybutu **Jednostka atrybutu value string 100 nie Wartość atrybutu unit string 100 nie Jednostka wartości atrybutu * Jeżeli chcesz podać numer artykułu producenta, wtedy wymagane jest także podanie nazwy producenta. **Mogą to być zarówno atrybuty wariantów jak i dodatkowe atrybuty produktu. *** Jeżeli ten identyfikator jest wysyłany dla więcej niż jednego produktu danej grupy wariantów, wtedy jest on zawsze nadpisywany.

26 9 Przykłady konfiguracji wariantów różnych asortymentów 9.1 Market budowlany Przykład: Sprzedajesz "gwoździe z łbem wpuszczanym w trzech wymiarach: 3,8 x 100 mm, 4,2 x 120 mm i 4,6 x 130 mm Postępujesz w następujący sposób: Wybierasz z przeglądu udostępnionych przez nas konfiguracji wariantów konfigurację "Wymiary". Tu możesz wpisać w polu tekstowym swoje wymiary, np. właśnie "3,8 x 100". Nazwą Twojej grupy wariantów powinna być po prostu nazwa produktu: "Gwoździe z łbem wpuszczanym", bez dopisków wymiarów poszczególnych artykułów. Konfiguracja wariantów Atrybut Wartość atrybutu 1 Wartość atrybutu 2 Wartość atrybutu 3 Wymiar Wymiar 3,8 x 100 4,2 x 120 4,6 x 130 Jedn.: mm mm mm 9.2 Książki Przykład: Prowadzisz księgarnię i sprzedajesz książkę Johna R. R. Tolkiena "Władca Pierścieni" w różnych formatach: jako wydanie zszywane, jako wydanie kieszonkowe i jako audiobook na CD. Postępujesz w następujący sposób: Wybierasz z przeglądu udostępnionych przez nas konfiguracji wariantów konfigurację "Format książki". "Format książki" podaje Ci wartości atrybutu, z których po prostu wybierasz właściwą. Nazwą Twojej grupy wariantów powinna być prosta nazwa produktu: "Władca Pierścieni", bez dodatkowych danych poszczególnych wydań. Konfiguracja wariantów Atrybut Wartość atrybutu 1 Wartość atrybutu 2 Wartość atrybutu 3 Format książki Format wydanie zszywane wydanie kieszonkowe audiobook na CD

27 9.3 Sprzęt elektroniczny powszechnego użytku Przykład: Prowadzisz sklep ze sprzętem elektronicznym i sprzedajesz "Apple ipod Nano" w różnych kolorach i z pamięcią o różnej wielkości. Postępujesz w następujący sposób: Wybierasz z przeglądu udostępnionych przez nas konfiguracji wariantów podwójną konfigurację "Kolor-Wielkość". "Kolor" wpisujesz w wolnym polu tekstowym, np. "czarny". "Wielkość" pamięci podajesz jako liczbę i możesz dodatkowo z podanych jednostek wybrać "GB", co oznacza gigabajty. Z tego wynika dla parametru "Wielkość", np. dana: 16 GB Nazwą Twojej grupy wariantów powinna być po prostu nazwa produktu: "Apple ipod Nano", bez dopisków jak kolor lub pamięć poszczególnych artykułów. Konfiguracja wariantów Atrybut Wartość atrybutu 1 Wartość atrybutu 2 Wartość atrybutu 3 Kolor Kolor czarny niebieski srebrny Wielkość Format Jedn. GB GB GB 9.4 Filmy Przykład: Oferujesz film "Alicja w Krainie Czarów" w różnych formatach, jako "DVD", "Bluray" i "Blu-ray 3D". Postępujesz w następujący sposób: Wybierasz z przeglądu udostępnionych przez nas konfiguracji wariantów konfigurację "Format filmu". "Format filmu" podaje Ci wartości atrybutu, z których po prostu wybierasz właściwą. Nazwą Twojej grupy wariantów powinna być prosta nazwa produktu: "Alicja w Krainie Czarów, bez dodatkowych danych poszczególnych wydań. Konfiguracja wariantów Atrybut Wartość atrybutu 1 Wartość atrybutu 2 Wartość atrybutu 3 Format filmu Format DVD Blu-ray Blu-ray 3D

28 9.5 Gry Przykład: Oferujesz grę "FIFA 12" w różnych formatach: na PC, Playstation 3 i Wii. Postępujesz w następujący sposób: Wybierasz z przeglądu udostępnionych przez nas konfiguracji wariantów konfigurację "Platforma gry". "Platforma gry" podaje Ci wartości atrybutu, z których po prostu wybierasz właściwą. Nazwą grupy wariantów powinna być prosta nazwa produktu: "FIFA12", bez dodatkowych danych poszczególnych artykułów. Konfiguracja wariantów Atrybut Wartość atrybutu 1 Wartość atrybutu 2 Wartość atrybutu 3 Platforma gier Platforma PC Playstation 3 Wii 9.6 Sprzęt AGD Przykład: Oferujesz "Kawiarkę Bodum Chambord" w dwóch kolorach "srebrnym" i "czarnym" i w trzech wielkościach 0,35 l, 1 l i 1,5 l. Postępujesz w następujący sposób: Wybierasz z przeglądu udostępnionych przez nas konfiguracji wariantów podwójną konfigurację "Kolor-Wielkość". "Kolor" wpisujesz w wolnym polu tekstowym, np. "czarny". "Wielkość", w tym przypadku daną w litrach, podajesz jako liczbę i możesz dodatkowo wybrać jednostkę np. "l" dla litra. Z tego wynika dla parametru "Wielkość", np. dana: "1,5 l". Nazwą grupy wariantów powinna być prosta nazwa produktu, bez dopisków jak dane o kolorze lub pojemności poszczególnych artykułów. Konfiguracja wariantów Atrybut Wartość atrybutu 1 Wartość atrybutu 2 Wartość atrybutu 3 Kolor Kolor czarny srebrny srebrny Wielkość Format Jedn. l l l

29 9.7 Artykuły spożywcze Przykład: Prowadzisz sklep z artykułami spożywczymi i oferujesz "Steki T-bone" w różnych ilościach: 2, 3 lub 5 sztuk. Postępujesz w następujący sposób: Wybierasz z przeglądu udostępnionych przez nas konfiguracji wariantów podwójną konfigurację "Wielkość". "Wielkość" to w tym przypadku "ilość sztuk", podaj liczbę i wybierz jedną jednostkę dowolnego wyboru, jak np. szt. Z tego wynika dla parametru "Wielkość", np. dana "5 szt.". Nazwą Twojej grupy wariantów powinna być po prostu nazwa produktu: "Steki T-bone", bez dopisków jak ilość, które charakteryzują poszczególne artykuły. Konfiguracja wariantów Atrybut Wartość atrybutu 1 Wartość atrybutu 2 Wartość atrybutu 3 Wielkość Wielkość Jedn. Szt. Szt. Szt. 9.8 Soczewki kontaktowe Przykład: Oferujesz soczewki kontaktowe o promieniu krzywizny 8,6 mm, o mocy -6,50, - 6,00 i -5,50 dioptrii i średnicy 14,2 mm. Postępujesz w następujący sposób: Wybierasz z przeglądu udostępnionych przez nas konfiguracji wariantów "Soczewki kontaktowe". Atrybuty "Promień krzywizny", "Moc" i "Średnica" można podać wraz z pasującymi jednostkami: mm dla "Promienia krzywizny", dioptrie dla "Mocy" i mm dla "Średnicy". Nazwą Twojej grupy wariantów powinna być po prostu nazwa produktu: "soczewki kontaktowe Richter 30 AS UV", bez dopisków, które charakteryzują poszczególne artykuły.

30 Konfiguracja wariantów Atrybut Promień krzywizny Wartość Wartość Wartość atrybutu 1 atrybutu 2 atrybutu Jedn. mm mm mm Soczewki kontaktowe Moc Jedn. dpt dpt dpt Średnica Jedn. mm mm mm

31 10 Przegląd konfiguracji wariantów internetowy Pasaż handlowy 10.1 Powszechnie stosowane konfiguracje wariantów Konfiguracja Atrybut Typ Wstępnie zdefiniowane wartości Kolor Kolor Tekst - - Wielkość Wielkość Liczba - Wymiar Wymiar Tekst - Kolor-Wielkość Kolor-Wymiar Kolor Tekst - - Wielkość Liczba - Kolor Tekst - - Jednostki opcjonalne ml, l, g, kg, mm, cm, m, m2, m3, MB, GB,TB, megapiksele, cale, szt., W mm, cm, m Wymiar Tekst - mm, cm, m Styl Styl Tekst - - Styl-Wielkość Styl Wielkość Tekst Liczba - - ml, l, g, kg, mm, cm, m, m2, m3, MB, GB,TB, megapiksele, cale, szt., W - ml, l, g, kg, szt., cl, dl Materiał Materiał Tekst - - Materiał-Wymiar Materiał-Wielkość Materiał Tekst - - Wymiar Tekst - Materiał Tekst - - Wielkość Liczba - Model Model Tekst - - mm, cm, m ml, l, g, kg, mm, cm, m, m2, m3, MB, GB,TB, megapiksele, cale, szt., W

32 10.2 Konfiguracje wariantów dla asortymentów Książka, Film i Gry Konfiguracja Atrybut Typ Format książki Format Tekst Format filmu Format Tekst Platforma gier Platforma Tekst Wstępnie zdefiniowane wartości wydanie zszywane wydanie kieszonkowe, broszura, audiobook CD kaseta audio DVD Blu-ray, Blu-ray 3D, Blu-ray + DVD, DVD + CD, HD-DVD, UMD wideo PC Mac, PlayStation, PlayStation 2, PlayStation 3, PlayStation Portable, Wii, Xbox, Xbox 360, Nintendo 3DS, Nintendo DS, Game Boy, Game Boy Advance, Game Cube, Nintendo 64, N-Gage, Sega Dreamcast, Sega Saturn Jednostki opcjonalne Konfiguracje wariantów soczewek kontaktowych Konfiguracja Atrybut Typ Soczewki kontaktowe Promień krzywizny Liczba - Wstępnie zdefiniowane wartości Jednostki opcjonalne mm Moc Liczba - dpt Średnica Liczba - mm

33 10.4 Konfiguracje wariantów dla asortymentu Moda Konfiguracja Atrybut Typ Wstępnie zdefiniowane wartości Ubrania z UE Ubrania z USA Skarpety Kolor Tekst - - Rozmiar Liczb a - - Kolor Tekst - - Rozmiar Tekst XXS, XS, S, M, L, XL, XXL, XXXL, 4XL, 5XL, 6XL, 7XL Kolor Tekst - - Rozmiar Tekst 15-18, 19-22, 23-26, 19-22, 23-26, 27-30, 31-34, 35-38, 39-42, 43-46, 47-48, Jednostki opcjonalne - - Jeans Biustonosze Kolor Tekst - - Długość Szerokość Liczb a Liczb a 28, 30, 32, 34, 36, 38, 40, 42 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60 Kolor Tekst - - Obwód biustu Miseczka Liczb a Tekst 45, 50, 55, 60, 65, 70, 75, 80, 85, 90, 95, 100, 105, 110, 115, 120, 125, 130, 135, 140, 145, 150 AA, A, B, C, D, DD, E, EE, F, FF, G, GG, H

34 11 Kategorie do pobrania 11.1 merytoryczny internetowy Pasaż handlowy daje możliwość pobrania przeglądu kategorii do Pasażu Handlowego oraz do własnego sklepu Sprzedającego. Pobieranie odbywa się poprzez "downloadrequest", a przy tym konieczne jest jedynie rozróżnienie pomiędzy pasażem handlowym i sklepem Sprzedającego. Wynik zawiera dodatkowo, oprócz kategorii z możliwą hierarchią, także nazwy i opisy wprowadzonych atrybutów, które stosuje się do wyszukania produktów lub do przeglądania fasetowego Definiowanie Poniższe dane są niezbędne do pobrania kategorii. Tabela zawiera atrybuty, które korespondują z opisem technicznym w następnym rozdziale i każdorazowo krótki opis zawartości.

35 Wywoływanie kategorii Struktura katalogu Nazwa Atrybut Typ Długość catalogstructure string nie Pole Podaje strukturę katalogu: Z "marketplace" dla Pasażu Handlowego, z "shop" dla sklepu Sprzedającego. Jeżeli nie zawiera żadnej wartości, to wysyłany jest sklep Sprzedającego. Informacja zwrotna opisu kategorii Nazwa Atrybut Typ Długość ID kategorii code string 100 tak Pole Unikalny ID kategorii sklepu. Każda kategoria posiada unikalny kod kategorii, który jednak w sklepie nie jest widoczny. Służy on do identyfikacji kategorii. Nazwa kategorii name string 100 tak Nazwa kategorii produktu. Ta nazwa jest wyświetlana w sklepie. kategorii shortdescription string 100 nie Krótki opis kategorii Kategoria nadrzędna Kategoria zablokowana parent string 100 nie ID nadrzędnej kategorii. deprecated boolean nie Jeżeli "prawda" wtedy nie można użyć tej kategorii do wysyłania produktów na serwer. Dlatego przesyła się tylko kategorie z "fałsz".

36 12 Oferty produktów do pobrania 12.1 merytoryczny Pasaż Handlowy daje Sprzedającemu możliwość pobrania przeglądu oferowanych przez niego produktów. Pobieranie odbywa się poprzez "downloadrequest". W wyniku wysyłany jest unikalny kod identyfikacyjny produktu, jak również specyficzna dla danego Sprzedającego oferta. Dostarczane są z powrotem zawsze wszystkie oferty produktu Sprzedającego Definiowanie Do pobrania ofert produktów nie jest wymagane podanie żadnych specyficznych danych, wystarcza wysłanie jedynie żądania. Informacja zwrotna opisu kategorii W informacji zwrotnej są wysyłane poniższe atrybuty. Tabela zawiera atrybuty, które korespondują z opisem technicznym w następnym rozdziale i każdorazowo krótki opis zawartości.

37 Nazwa Atrybut Typ Długość ID produktu Sprzedającego Pasaż handlowy ID produktu European article number Pole productid string 100 tak Wewnętrzny i unikalny numer artykułu Sprzedającego meinpaketid string 100 nie Unikalny numer artykułu internetowy Pasaż handlowy Ean string 13 nie Producent manufacturername string 100 nie Nazwa producenta* Numer artykułu producenta Cena jednostkowa "European Article Number", EAN produktu. Dla książek ISBN-13. manufacturerpn string 100 nie Numer artykułu producenta unitprice doubl e Jednostka miary Unit string 100 nie Klasyfikacja podatkowa Dostępność Data początkowa taxgroup availability startdate taxgr oup intege r dateti me nie nie tak nie Cena na każdą jednostkę Jednostka ilości produktu: Sztuka = per_piece Kilogram = per_1kg Litr = per_1l Metr sześcienny = per_1m3 Metr = per_1m Metr kwadratowy = per_1m2 Gram = per_100g Mililitr = per_100ml Podatek VAT zawarty w cenie sprzedaży. "Standard" (aktualnie 19%), "Reducted" (aktualnie 7%) i "Free" dla artykułów bez podatku VAT. Jeżeli to pole nie jest wypełnione, wtedy jest ustawiany "Standard". Dostępna liczba sztuk tego produktu. Liczba sztuk przy każdej sprzedaży jest automatycznie przeliczana w dół. Jeżeli liczba sztuk wynosi 0 wtedy produkt jest wyświetlany jako wyprzedany. Data, od kiedy produkt jest dostępny do zamówień Klienta, tzn. jest widoczny w Pasażu Handlowym u tego Sprzedającego. Data musi być wysłana w

38 Nazwa Atrybut Typ Długość Data zakończenia Kategoria w sklepie Sprzedającego enddate shopcategory dateti me categ oryref Pole nie następującym formacie: YYYY-MM-DDThh:mm:ss ** Data, od której produkt nie jest już dostępny, tzn. nie jest ani widoczny, ani nie można go zamówić. Data musi być wysłana w następującym formacie: YYYY-MM-DDThh:mm:ss ** 100 nie Kategoria produktu we własnym sklepie Sprzedającego*** * Jeżeli chcesz podać numer artykułu producenta, wtedy wymagane jest także podanie nazwy producenta. ** Format datetime ma następującą specyfikację "YYYY-MM-DDThh:mm:ss" przy czym: - YYYY rok - MM miesiąc - DD dzień - T oznaczenie, oznaczenie, że od tego miejsca zaczyna się format czasu - hh godziny - mm minuty - ss sekundy *** Wysyła się tylko wtedy, jeżeli Sprzedający zdefiniował własną strukturę kategorii.

39 13 Wywołanie wskaźników 13.1 merytoryczny Dla każdego Sprzedającego na All You Need w odniesieniu do różnych usług interfejsów jest dostępny określony wskaźnik, tzn. jak często możesz korzystać z danej usługi. I na przykład, odnośnie wysyłania danych produktu jest on zależny od tego, jak dużo masz produktów i ofert. Dzięki temu gwarantujemy, że dla każdego Sprzedającego jest dostępnych wystarczająco dużo zasobów interfejsu. Ponadto zapewnia to czystą i wydajną pracę podłączenia do All You Need. Za pomocą zdefiniowanego tu żądania możesz wywołać Twój aktualny dostępny wskaźnik. W sytuacji gdy miałby on nie być wystarczający (może to wystąpić głównie w przypadku nowych Sprzedających bez produktów) proszę o kontakt z Działem Wparcia (patrz Rozdział 24 dane kontaktowe) Definiowanie Do pobrania ofert produktów nie jest potrzebne podanie żadnych specyficznych danych, wystarcza wysłanie żądania. Informacja zwrotna o wskaźniku W informacji zwrotnej są wysyłane poniższe atrybuty. Tabela zawiera atrybuty i ich opis zawartości. Nazwa Atrybut Typ Długoś ć Nazwa usługi name string 100 tak Dostępne żądania Dostępne wywołania Dostępne żądania Częstotliwość wywoływania Jednostka częstotliwości availablesingle Request availablecallco unt availableconcur rentrequest availablefreque ncy int int int int Pole nie nie nie nie frequencyunit int nie Nazwa usługi, która jest ograniczona wskaźnikiem. Podaje dostępną jeszcze liczbę żądań danej usługi. Podaje dostępną jeszcze liczbę wywołań danej usługi. Ten parametr obecnie nie jest jeszcze wykorzystywany. Podaje liczbę żądań, które mogą jeszcze zostać ustawione w asynchronicznej kolejce oczekiwania. Podaje częstotliwość, z jaką można ustawić nowe żądania danej usługi. Ten parametr obecnie nie jest jeszcze wykorzystywany. Jednostka częstotliwości. Możliwe wartości: TYDZIEŃ, DZIEŃ, GODZINA, MINUTA

40 14 Usuwanie 14.1 merytoryczny Na All You Need można usuwać opisy produktów, oferty produktów i kategorie sklepu. Jeżeli są zamieszczone tylko oferty produktów, wtedy Sprzedający może usunąć tylko tę ofertę. Jeżeli Sprzedający ma oferty produktów i opisy produktów, wtedy można usunąć je tylko razem. Żądanie jest w obydwu wypadkach identyczne. Pasaż Handlowy uniemożliwia usuwanie tak długo, dopóki są otwarte zamówienia określonego produktu. Tak samo nie można usunąć kategorii, jeżeli zawierają one jeszcze jakieś produkty Definiowanie Poniższe dane są niezbędne do pobrania kategorii. Tabela zawiera atrybuty i ich opis zawartości.

41 Usuwanie kategorii Struktura katalogu Nazwa Atrybut Typ Długość catalogstructure string nie Pole Dla Pasażu Handlowego należy tu wpisać "marketplace", dla własnego sklepu można wpisać "shop", jeśli pole nie będzie zawierać żadnej wartości, zostanie wysłany sklep Sprzedającego. Usuwanie produktów Nazwa Atrybut Typ Długość ID produktu Sprzedającego Pasaż handlowy ID produktu European article number Pole productid string 100 tak Wewnętrzny i unikalny numer artykułu Sprzedającego meinpaketid string 100 nie Unikalny numer artykułu Pasaż handlowy ean string 13 nie European Article Number, EAN produktu. Dla książek ISBN-13 Producent manufacturername string 100 nie Nazwa producenta Numer artykułu producenta manufacturerpn string 100 nie Numer artykułu producenta

42 15 Podstawy merytoryczne i przegląd interfejsów procesu zamówienia Między All You Need, Klientami, a Sprzedającymi mają miejsce różne etapy komunikacji. Proces ten rozpoczyna się poprzez zamówienie Klienta, złożone w Pasażu Handlowym, zakupów on-line. Klient może zamówić jeden lub kilka produktów, u jednego lub kilku Sprzedających. Ma to miejsce wtedy, gdy Klient idzie ze swoim koszykiem "do kasy" i kończy swoje zamówienie. Pasaż Handlowy udostępnia dla każdego Sprzedającego złożone zamówienia jako "Zamówienie" gotowe do wywołania. Sprzedający może sam wybrać czas, w którym on wywołuje zamówienia, jak również częstotliwość wywołań. Zamówienie może być wywoływane dowolnie często. Może to się odbywać poprzez podanie okresu i statusu lub poszczególnych numerów zamówień. Gdy tylko zamówiony towar zostanie wysłany w przesyłce przez Sprzedającego, przekazuje on tę informację do Pasażu Handlowego. W ten sposób zostaje uruchomiony proces zapłaty, który w tym dokumencie nie będzie szerzej omawiany. Sprzedający może z informacją o przesyłce wysłać jednocześnie dane do śledzenia przesyłki, o ile są one już znane. Informacje do śledzenia przesyłki mogą również zostać przekazane później. Po podaniu informacji dotyczących przesyłki, dostawa i faktura muszą zostać wysłane do Klienta.

43 Klient może z różnych powodów odesłać z powrotem do Sprzedającego dostawę lub także w przypadku kilku produktów tylko część z nich. Może to nastąpić z powiadomieniem lub bez. Sprzedający ocenia te zwroty i przekazuje informację do All You Need. Tam rozpoczyna się odpowiednia procedura cofnięcia zapłaty. Sprzedający może anulować zamówienia produktów, które nie są już dostępne. Możliwe jest anulowanie całego zamówienia lub także, w przypadku kilku produktów, również jedynie jego części. Sprzedający przekazuje informację o anulowaniu zamówienia do All You Need, które przekazuje informację do Klienta. Dla Klienta nie przewidziano procesu anulowania zamówienia. Może on jedynie wysłać zapytanie, czy można przeprowadzić anulowanie zamówienia. Sprzedający otrzymuje taką informację pocztą elektroniczną i może, o ile jest to jeszcze możliwe w procesie wysyłki, uruchomić procedurę anulowania zamówienia. Jeśli życzenie Klienta, aby anulować zamówienie nie zostanie uwzględnione, Klient może skorzystać z możliwości zwrotu. Przegląd całego procesu zamówienia, poszczególne etapy tego procesu, zostały zestawione dla Sprzedającego w poniższej tabeli. Ze szczegółowym i technicznym opisem można się zapoznać w rozdziałach od 16 do 20: Etapy procesu zamówienia Wywołanie zamówień Zgłoszenie przesyłki Anulowanie Informacje dotyczące śledzenia przesyłki Zwroty Sprzedający musi w regularnych odstępach czasu (np. co 60 min) wywoływać nowe zamówienia. Jeżeli są zamówienia, udostępnia się je Sprzedającemu w formie pliku XML. Zamówiony towar wysyłany jest przez Sprzedającego do Klienta. Musi to zostać zgłoszone do All You Need. Artykuły, które nie mogą zostać dostarczone, należy wysłać do All You Need jako anulowanie zamówienia Jeżeli informacji dotyczących śledzenia przesyłki nie ma w zgłoszeniu przesyłki, można je przekazać później. Jeżeli Sprzedający otrzyma z powrotem towar od Klienta, należy to zgłosić do All You Need. Po takim zgłoszeniu rozpoczyna się procedura cofnięcia zapłaty. Diagram przebiegu tego procesu patrz załącznik B. Do technicznego opisu (interfejsu) API istnieją dwa pliki xsd, common.xsd i orders.xsd. Plik common.xsd zawiera definicje ogólne, które używane są także w dalszych zakresach API Sprzedającego. Plik orders.xsd zawiera opisane w poniższych rozdziałach żądania oraz specyficzne definicje tego interfejsu.

44 16 Zamówienie 16.1 merytoryczny Zamówienie w tym rozdziale rozpatrywane jest jako zakup towarów na All You Need i w poszczególnych sklepach Sprzedających. Jeżeli Klient idzie z jednym lub kilkoma produktami w koszyku do kasy, rozpoczyna on tym samym proces zamówienia. Jeżeli proces ten jest zakończony, wtedy Sprzedający może wywołać kompletne informacje dotyczące zamówienia w formie pliku XML. Sprzedający może wywołać wszystkie zamówienia lub tylko te otwarte w wybranym okresie. Poszczególne zamówienia można wywołać na podstawie ID zamówienia "OrderId" lub swojego wewnętrznego numeru zamówienia Sprzedającego. Plik zawiera wszystkie wymagane informacje zamówienia, a Sprzedający ma teraz obowiązek przygotować odpowiedni towar do wysyłki, wystawić Klientowi fakturę i na koniec wysłać ten towar wraz z fakturą. Gdy tylko towar zostanie wysłany, należy przekazać tę informację do All You Need aby mógł zostać uruchomiony proces zapłaty. Jeżeli towar, wbrew ofercie w Pasażu Handlowym lub w sklepie Sprzedającego, nie może zostać dostarczony, Sprzedający musi niezwłocznie anulować daną pozycję zamówienia lub ewentualnie całe zamówienie (patrz rozdział 19) Zamówienie podzielone jest na różne obszary, unikalna identyfikacja, pozycje zamówienia, adres dostawy lub adres do faktury, dane kontaktowe i rodzaj przesyłki. Ogólnym nr referencyjnym zamówienia jest unikalny numer zamówienia. Do każdego numeru zamówienia należą jedna lub kilka pozycji zamówienia z odpowiednimi informacjami szczegółowymi. Do wysyłki wymagany jest adres dostawy. Dodatkowo istnieje taka możliwość, że adres dostawy jest inny niż adres na fakturze. Ponadto Klient ma możliwość wybrania rodzaju przesyłki. Do celów ewentualnych zapytań Sprzedającego dostarczany jest dodatkowo informacyjnie numer Klienta. Opcjonalnie Sprzedający ma możliwość wymagania wraz z wywołaniem zamówienia również adresu poczty elektronicznej Klienta. W przypadku tego adresu poczty elektronicznej chodzi o adres wirtualny, który jest przekazywany przez All You Need. Możesz również, jeśli sprzedajesz towary spedycyjne, poprosić o podanie Ci numeru telefonu Klienta, w celu omówienia dostawy. Jeżeli część zamówienia została właśnie wysłana przez Sprzedającego do Klienta i zostało to również zgłoszone do All You Need, to takie informacje będą również zawarte w danych.