Do czego służy ta instrukcja
Ten artykuł pokazuje, jak utworzyć integrację z własnym sklepem przez REST API xSale. Integracja jest potrzebna m.in. do obsługi ofert i zamówień pochodzących z Twojego sklepu, gdy integracja nie jest realizowana przez gotowy konektor.
Na początku znajdziesz skrótowy opis kroków i wymagania, a dalej część techniczną z endpointem i przykładami (pozostawioną bez zmian).
W tym artykule znajdziesz
- kiedy warto tworzyć integrację z własnym sklepem przez API
- wymagania i dane wejściowe
- szybki przepis krok po kroku
- typowe problemy i sposób weryfikacji
Kiedy stosować
To rozwiązanie stosuje się, gdy chcesz połączyć xSale z własnym sklepem lub systemem sprzedażowym poprzez integrację realizowaną po Twojej stronie. Po utworzeniu integracji możesz m.in. tworzyć oferty, pobierać zamówienia i przetwarzać procesy związane z integracją.
Wymagania
- dostęp do REST API xSale (autoryzacja) dla właściwej organizacji
- wartość organizationName
- nazwa integracji (Name)
- typ integracji: IntegrationType = 28
Szybki przepis (krok po kroku)
- Przygotuj nazwę integracji i ustaw IntegrationType = 28.
- Wyślij zapytanie tworzące integrację na endpoint
POST /{organizationName}/integrations. - W odpowiedzi zapisz identyfikator utworzonej integracji (będzie potrzebny w kolejnych endpointach).
- Zweryfikuj w xSale, czy integracja jest widoczna na liście integracji.
Typowe problemy i jak je sprawdzić
- Błąd autoryzacji — sprawdź dane logowania/token oraz uprawnienia do REST API.
- Niepoprawny typ integracji — upewnij się, że przekazujesz IntegrationType = 28.
- Integracja nie pojawia się w panelu — odśwież listę integracji i sprawdź odpowiedź API (czy operacja zakończyła się sukcesem).
Szczegóły techniczne
Integrację z własnym sklepem utworzysz korzystając z endpointu:
POST /{organizationName}/integrations
Minimalny zakres danych, wymagany do utworzenia integracji, to nazwa (Name) i typ integracji (przekaż wartość 28 w polu IntegrationType). Włączona integracja zapewnia możliwość tworzenia aktywnych ofert oraz wybieranie i przetwarzanie procesów związanych z integracjami z systemami ERP. Szczegółowy opis dodawania integracji w interfejsie xSale znajdziesz w tym poradniku.
Przykładowy JSON:
{
„Name”: „domenasklepu.pl„,
„IsActive”: true,
„IntegrationType”: 28
}
Tworząc integrację możesz od razu wprowadzić ustawienia, które zapewnią eksport zamówień na wybrany magazyn w systemie ERP, tworzenie dokumentów sprzedaży ze wskazaną serią oraz brak wysyłania w zamówieniach eksportowanych do ERPa pozycji z transportem przy darmowej dostawie. Prześlij żądane wartości w poniższych polach:
- ExportToWarehouse – kod magazynu w systemie ERP zintegrowanym z twoją bazą xSale (Comarch ERP Optima, Comarch ERP XL lub Subiekt GT)
- ERPDocumentSerialNumber – domyślna seria, jaką mają otrzymać dokumenty tworzone w systemie ERP (więcej informacji zawiera ten poradnik)
- ExportWithoutTransport – prześlij true, aby zamówienia wysyłane do systemu ERP nie zawierały pozycji z transportem, gdy wysyłka jest darmowa
Jeśli chcesz wprowadzić wszystkie ustawienia przy tworzeniu integracji, skorzystaj z przykładu poniżej:
{
„Name”: „domenasklepu.pl„,
„IsActive”: true,
„IntegrationType”: 28,
„OrderSynchronization”: {
„ExportToWarehouse”: „MAG-1„,
„ERPDocumentSerialNumber”: „ECOM„,
„ExportWithoutTransport”: true
}
}
