Do utworzenia ofert połączonych z integracją z własnym sklepem wymagane jest zdefiniowanie i przypisanie kategorii. Optymalnym rozwiązaniem jest stworzenie drzewa kategorii, które odzwierciedla strukturę kategorii i podkategorii we własnym sklepie. W tym wpisie znajdziesz szczegóły dotyczące tworzenia kategorii i podkategorii.
Dodawanie kategorii
Aby dodać nową kategorię, wykorzystaj endpoint:
POST /{organizationName}/integrations/{id}/categories
Jedynym obowiązkowym polem w zapytaniu jest Name – przekaż w nim nazwę tworzonej kategorii. Opcjonalnie możesz podać zewnętrzne ID kategorii (ForeignId) – wykorzystanie tej możliwości pozwala na optymalne zarządzanie mapowaniami kategorii pomiędzy sklepem a xSale.
Jeśli kategoria została prawidłowo utworzona, serwer zwróci kod odpowiedzi 201 oraz ID utworzonej kategorii.
Identyfikator integracji z własnym sklepem
Do przesłania zapytania wymagane jest ID integracji ze sklepem własnym. Możesz je sprawdzić na dwa sposoby:
1. W interfejsie aplikacji xSale
Otwórz integrację z własnym sklepem w xSale i odczytaj ID integracji z adresu URL. Przejdź do zakładki Integracje – Integracje i kliknij w kafelek swojej integracji z własnym sklepem. ID integracji zobaczysz w pasku przeglądarki:
2. Za pomocą REST API
Odpytaj endpoint GET /{organizationName}/integrations, aby pobrać listę integracji. Odpowiedź możesz zawęzić do integracji z własnym sklepem, używając filtra typein (podaj wartość 28).
Jeśli integracja nie została jeszcze utworzona, utwórz ją w interfejsie xSale lub dodaj integrację ze sklepem własnym przez REST API.
Dodawanie podkategorii
Aby dodać kategorię niższego rzędu, w zapytaniu na endpoint POST /{organizationName}/integrations/{id}/categories przekaż ID kategorii nadrzędnej (ParentId).
Pobieranie kategorii
Kategorie utworzone w xSale dla integracji z własnym sklepem możesz pobrać na kilka sposobów:
1. Wykorzystaj poniższy endpoint, który umożliwia wyszukiwanie wśród istniejących kategorii:
GET /{organizationName}/integrations/{id}/categories/search
W zapytaniu przekaż ID integracji z własnym sklepem. Możesz wyszukiwać po nazwie kategorii (name), ID kategorii (categoryidequals) i ID kategorii zewnętrznej (foreigncategoryidequals). Jeśli nie użyjesz dodatkowych filtrów, API zwróci tablicę złożoną z pełnych ścieżek dla wszystkich kategorii, zaczynając od kategorii najniższego rzędu, a kończąc na kategorii nadrzędnej.
2. Użyj endpointu zwracającego podkategorie dla wskazanej kategorii:
GET /{organizationName}/integrations/{id}/categories/subcategories
W zapytaniu przekaż ID integracji z własnym sklepem.
3. Pobierz całą gałąź dla wskazanej kategorii korzystając z endpointu:
GET /{organizationName}/integrations/{id}/categories/{categoryId}/branch
W zapytaniu przekaż ID integracji z własnym sklepem oraz ID kategorii.
4. Pobierz szczegóły wybranej kategorii wysyłając zapytanie na endpoint:
GET /{organizationName}/integrations/{id}/categories/{categoryId}
W zapytaniu przekaż ID integracji z własnym sklepem oraz ID kategorii.
