Witaj w centrum pomocy Apilo
[API] Dokumenty powiązane w zamówieniach
Spis treści
Dodawanie dokumentu powiązanego do zamówienia
1. Przygotowanie danych
Najpierw przygotuj dane, które chcesz wysłać w żądaniu. Dane powinny posiadać pola obowiązkowe oraz opcjonalne, jeśli zapytanie tego wymaga.
Typ dla dokumentu można pobrać z endpoint
shell GET /rest/api/orders/documents/map/
Wymagane:
JSON
{
„idExternal”: „1”,
„type”: 16,
}
Opcjonalne:
JSON
{
„idExternal”: „1”,
„number”: „FV/1/12/2020”,
„priceWithTax”: 123,
„priceWithoutTax”: 100,
„currency”: „PLN”,
„currencyValue”: 1,
„type”: 16,
„media”: „2ed996a6-0b91-529c-9728-f2e59532e7bc”
}
2.Wybór narzędzia do wysyłania żądania
Możesz użyć różnych narzędzi do wysyłania żądań HTTP, takich jak Postman, cURL, czy biblioteki w językach programowania (np. requests w Pythonie).
3. Wysłanie żądania
Poniżej znajduje się przykład, jak wysłać żądanie za pomocą cURL:
shell
curl -X POST „https://twoja-domena.pl/rest/api/orders/{id}/documents/” \
-H „Accept: application/json” \
-H „Content-Type: application/json” \
-d '{
„idExternal”: „1”,
„number”: „FV/1/12/2020”,
„priceWithTax”: 123,
„priceWithoutTax”: 100,
„currency”: „PLN”,
„currencyValue”: 1,
„type”: 16,
„media”: „2ed996a6-0b91-529c-9728-f2e59532e7bc”
}
4. Obsługa odpowiedzi
Po wysłaniu żądania, serwer zwróci odpowiedź. Upewnij się, że obsługujesz odpowiedzi, takie jak:
- dokument istnieje (kod 200)
- dokument został utworzony (kod 201)
- błędy (np. kod 401 404, 422).
Pobieranie listy dokumentów w zamówieniach
1. Zalecana filtracja listy zamówień
shell
GET /rest/api/orders/
W celu otrzymania tylko zamówień, które posiadają dokumenty powiązane oraz wykluczenia z listy zamówień, które ich nie posiadają, zalecamy stosowania filtra:
isOrderDocument=1
Przykład:
shell
GET rest/api/orders/isOrderDocument=1
2.Lista dokumentów powiązanych dla zamówienia
W celu wyświetlenia konkretnego dokumentu powiązanego do zamówienia, zalecamy użycie endpoint
shell
GET /rest/api/orders/{id}/documents/
z odpowiednimi filtrami.
3. Filtry
<b>id</b>– wyświetlenie pojedynczego dokumentu powiązanego do zamówienia po id dokumentu
shell
GET /rest/api/orders/{id}/documents/?id=1
<b>idExternal</b> – wyświetlenie dokumentu powiązanego do zamówienia po id zewnętrznym
shell
GET /rest/api/orders/{id}/documents/?idExternal=”1″
<b>number</b> – wyświetlenie dokumentu powiązanego do zamówienia po numerze dokumentu
shell
GET /rest/api/orders/{id}/documents/?number=”FV/1/12/2020″
<b>type</b> – wyświetlenie dokumentów powiązanego do zamówienia po typie dokumentu
<b>createdAfter</b> – wyświetlenie dokumentów powiązanych do zamówienia z zakresu: od podanej wartości daty
<b>CreatedBefore</b> – wyświetlenie dokumentów powiązanych do zamówienia z zakresu: sprzed podanej wartości daty
4. Zalecenie filtrów
W celu efektywnego przeszukiwania dokumentów powiązanych na liście zaleca się używania filtrów createdAfter i createdBefore jednocześnie oraz wybranie odpowiedniego typu dokumentu do wyświetlenia.
Przykład:
shell
GET /rest/api/orders/{id}/documents/?type=16&createdAfter=”2024-09-01T00%3A0%3A00%2B01%3A00″&createdBefore=”2024-10-01T00%3A0%3A00%2B01%3A00″
Pobieranie szczegółów dokumentów
W celu wyświetlenia szczegółów dokumentów powiązanych zaleca się używanie dedykowanego endpointu:
shell GET /rest/api/orders/{id}/documents/{document}/
Nadal potrzebujesz pomocy?
Porozmawiaj z konsultantem
