{"openapi":"3.0.0","paths":{"/oauth/authenticate":{"get":{"operationId":"authenticate","parameters":[],"responses":{"200":{"description":""}},"tags":["OAuth"]}},"/oauth/authorize":{"post":{"operationId":"authorize","parameters":[],"responses":{"201":{"description":""}},"tags":["OAuth"]}},"/oauth/token":{"post":{"operationId":"token","parameters":[],"responses":{"201":{"description":""}},"tags":["OAuth"]}},"/v1/user":{"get":{"operationId":"profile","summary":"Pobieranie danych użytkownik","description":"Metoda służy do pobierania danych z profilu użytkownika.","parameters":[],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfileData"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}}},"security":[{"bearer-token-for-user":[]}],"tags":["Profil"]},"put":{"operationId":"updateProfile","summary":"Aktualizacja danych użytkownik","description":"Metoda służy do aktualizowania danych użytkownika w profilu.","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfileData"}}}},"responses":{"204":{"description":"No content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}}},"security":[{"bearer-token-for-user":[]}],"tags":["Profil"]}},"/v1/user/employee":{"get":{"operationId":"employee","summary":"Dane opiekuna","description":"Metoda służy do pobierania danych kontaktowych do opiekuna, przypisanego do użytkownika. W przypadku braku przypisanego pracownika, zwraca dane kontaktowe do BOK","parameters":[],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmployeeResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}}},"security":[{"bearer-token-for-user":[]}],"tags":["Profil"]}},"/v1/user/balance":{"get":{"operationId":"balance","summary":"Pobieranie wartości salda","description":"Metoda służy do sprawdzenia aktualnego stanu środków na saldzie użytkownika.","parameters":[],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BalanceResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}}},"security":[{"bearer-token-for-user":[]}],"tags":["Profil"]},"post":{"operationId":"addCredit","summary":"Doładowanie salda","description":"Metoda zwraca dane do wykonania płatności, w celu doładowania salda użytkownika.","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddCreditDataPayload"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}}},"security":[{"bearer-token-for-user":[]}],"tags":["Profil"]}},"/v1/user/invoice/receiver":{"get":{"operationId":"getInvoiceReceiverData","summary":"Dane odbiorcy do faktury","description":"Metoda służy do pobierania zapisanych danych odbiorcy dla faktur użytkownika.","parameters":[],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceReceiverData"}}}},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}}},"security":[{"bearer-token-for-user":[]}],"tags":["Profil"]},"put":{"operationId":"updateInvoiceReceiverData","summary":"Aktualizacja danych odbiorcy do faktury","description":"Metoda służy do zapisywania lub aktualizacji danych odbiorcy dla faktur użytkownika.","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceReceiverData"}}}},"responses":{"204":{"description":"No content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}}},"security":[{"bearer-token-for-user":[]}],"tags":["Profil"]},"delete":{"operationId":"deleteInvoiceReceiverData","summary":"Usuwanie danych odbiorcy do faktury","description":"Metoda służy do usuwania zapisanych danych odbiorcy dla faktur użytkownika.","parameters":[],"responses":{"204":{"description":"No content"},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}}},"security":[{"bearer-token-for-user":[]}],"tags":["Profil"]}},"/v1/users":{"get":{"operationId":"ordersByIds","summary":"Lista użytkowników po id","description":"Metoda służy do pobrania listy użytkowników po podanych id.","parameters":[{"name":"ids","required":true,"in":"query","description":"Lista identyfikatorów użytkowników w systemie epaka.pl","schema":{"example":[1,2,3],"type":"array","items":{"type":"number"}}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UsersResponse"}}}}},"security":[{"bearer-token-for-service":[]}]}},"/v1/user/orders":{"get":{"operationId":"orders","summary":"Zamówienia","description":"Metoda służy do zwracania listy zamówień, złożonych przez użytkownika.","parameters":[{"name":"query","required":false,"in":"query","description":"Tekst do do wyszukania w zamówieniu","schema":{"type":"string"}},{"name":"id","required":false,"in":"query","description":"Identyfikator zamówienia","schema":{"type":"integer"}},{"name":"courierId","required":false,"in":"query","description":"Identyfikator kuriera","schema":{"type":"integer"}},{"name":"dateFrom","required":false,"in":"query","description":"Data zamówienia od, w standardzie ISO 8601","schema":{"example":"2024-12-22","type":"string"}},{"name":"dateTo","required":false,"in":"query","description":"Data zamówienia do, w standardzie ISO 8601","schema":{"example":"2024-12-22","type":"string"}},{"name":"dateCodFrom","required":false,"in":"query","description":"Data zwrotu pobrania od, w standardzie ISO 8601","schema":{"example":"2024-12-22","type":"string"}},{"name":"dateCodTo","required":false,"in":"query","description":"Data zwrotu pobrania do, w standardzie ISO 8601","schema":{"example":"2024-12-22","type":"string"}},{"name":"shippingType","required":false,"in":"query","description":"Rodzaj wysyłki:
envelope - Koperta
package - Paczka
pallet - Paleta
","schema":{"enum":["envelope","package","pallet"],"type":"string"}},{"name":"packageStatus","required":false,"in":"query","description":"Status przesyłki","schema":{"enum":["package_no_send","package_received_from_sender","package_on_transit","package_in_delivery","package_delivered","package_delivery_problem","package_damaged","wrong_address","return_to_sender","package_sending_in_point","package_waiting_in_point","package_sending_in_paczkomat","package_waiting_in_paczkomat"],"type":"string"}},{"name":"orderStatus","required":false,"in":"query","description":"Status zamówienia","schema":{"enum":["waiting_for_payment","in_progress","ended","errors","canceled","paid"],"type":"string"}},{"name":"cod","required":false,"in":"query","description":"Zamówienia z pobraniem","schema":{"type":"boolean"}},{"name":"delivered","required":false,"in":"query","description":"Zamówienia doręczone","schema":{"type":"boolean"}},{"name":"offset","required":false,"in":"query","description":"Offset do paginacji","schema":{"type":"integer"}},{"name":"limit","required":false,"in":"query","description":"Limit zwracanych zamówień","schema":{"default":10,"type":"integer"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderListResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}}},"tags":["Zamówienia"],"security":[{"bearer-token-for-user":[]}]}},"/v1/user/orders/{id}":{"get":{"operationId":"orderDetails","summary":"Szczegóły zamówienia","description":"Metoda służy do pobierania szczegółów wybranego zamówienia.","parameters":[{"name":"id","required":true,"in":"path","description":"Identyfikator zamówienia w systemie epaka.pl","schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderDetailsResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}}},"tags":["Zamówienia"],"security":[{"bearer-token-for-user":[]}]}},"/v1/user/orders/{id}/documents":{"get":{"operationId":"documentsAvailability","summary":"Dostępność dokumentów","description":"Metoda służy do zwrócenia informacji, które dokumenty są dostępne dla wybranego zamówienia.","parameters":[{"name":"id","required":true,"in":"path","description":"Identyfikator zamówienia w systemie epaka.pl","schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AvailabilityResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}}},"tags":["Zamówienia"],"security":[{"bearer-token-for-user":[]}]}},"/v1/user/orders/{id}/payment":{"get":{"operationId":"getPaymentData","summary":"Dane płatności dla zamówienia","description":"Metoda służy do zwracania danych płatności za zamówienie.","parameters":[{"name":"id","required":true,"in":"path","description":"Identyfikator zamówienia w systemie epaka.pl","schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentData"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}}},"tags":["Zamówienia"],"security":[{"bearer-token-for-user":[]}]}},"/v1/user/orders/{id}/cancel":{"patch":{"operationId":"cancelOrder","summary":"Anulowanie zamówienia","description":"Metoda służy do anulowania złożonego zamówienia.","parameters":[{"name":"id","required":true,"in":"path","description":"Identyfikator zamówienia w systemie epaka.pl","schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseApiResponse"}}}},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}}},"tags":["Zamówienia"],"security":[{"bearer-token-for-user":[]}]}},"/v1/user/orders/{id}/payment-status":{"get":{"operationId":"checkOrderStatus","summary":"Sprawdzanie statusu płatności dla zamówienia","description":"Metoda służy do sprawdzenia statusu płatności po złożeniu i opłaceniu zamówienia.","parameters":[{"name":"id","required":true,"in":"path","description":"Identyfikator zamówienia w systemie epaka.pl","schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderPaymentStatusResponse"}}}}},"tags":["Zamówienia"],"security":[{"bearer-token-for-user":[]}]}},"/v1/user/orders/{id}/{type}":{"get":{"operationId":"getDocument","summary":"Pobieranie dokumentów do zamówienia","description":"Metoda służy do pobieranie wybranego rodzaju dokumentu dla zamówienia.","parameters":[{"name":"id","required":true,"in":"path","description":"Identyfikator zamówienia w systemie epaka.pl","schema":{"type":"integer"}},{"name":"type","required":true,"in":"path","description":"Rodzaj dokumentu do pobrania.","schema":{"enum":["label","label-zebra","proforma","protocol","authorization-document","exporter-statement","lv-document","hvEcx-document"],"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Document"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}}},"tags":["Zamówienia"],"security":[{"bearer-token-for-user":[]}]}},"/v1/orders":{"get":{"operationId":"ordersByIds","summary":"Lista zamówień po id","description":"Metoda służy do pobrania listy zamówień po podanych id.","parameters":[{"name":"ids","required":true,"in":"query","description":"Lista identyfikatorów zamówień w systemie epaka.pl","schema":{"example":[1,2,3],"type":"array","items":{"type":"number"}}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrdersResponse"}}}}},"security":[{"bearer-token-for-service":[]}]}},"/v1/user/address-book":{"get":{"operationId":"getAddresses","summary":"Pobieranie listy adresów z książki adresowej","parameters":[{"name":"query","required":false,"in":"query","description":"Tekst do do wyszukania","schema":{"type":"string"}},{"name":"city","required":false,"in":"query","description":"Miasto","schema":{"example":"Łuków","type":"string"}},{"name":"street","required":false,"in":"query","description":"Ulica","schema":{"example":"Sochacz","type":"string"}},{"name":"phone","required":false,"in":"query","description":"Numer telefonu","schema":{"example":"123456789","type":"string"}},{"name":"offset","required":false,"in":"query","description":"Offset do paginacji","schema":{"type":"integer"}},{"name":"limit","required":false,"in":"query","description":"Limit zwracanych zamówień","schema":{"default":10,"type":"integer"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddressBookResponse"}}}},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}}},"tags":["Książka adresowa"],"security":[{"bearer-token-for-user":[]}]},"post":{"operationId":"createAddress","summary":"Dodawanie nowego adresu","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddressBookDataPayload"}}}},"responses":{"204":{"description":"No content"},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}}},"tags":["Książka adresowa"],"security":[{"bearer-token-for-user":[]}]}},"/v1/user/address-book/{id}":{"get":{"operationId":"getAddress","summary":"Pobieranie szczegółów wybranego adresu","parameters":[{"name":"id","required":true,"in":"path","description":"Identyfikator adresu w systemie epaka.pl","schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddressBookDetailsResponse"}}}},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}}},"tags":["Książka adresowa"],"security":[{"bearer-token-for-user":[]}]},"put":{"operationId":"editAddress","summary":"Edycja adresu","parameters":[{"name":"id","required":true,"in":"path","description":"Identyfikator adresu w systemie epaka.pl","schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddressBookDataPayload"}}}},"responses":{"204":{"description":"No content"},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}}},"tags":["Książka adresowa"],"security":[{"bearer-token-for-user":[]}]},"delete":{"operationId":"deleteAddress","summary":"Usuwanie adresu z książki","parameters":[{"name":"id","required":true,"in":"path","description":"Identyfikator adresu w systemie epaka.pl","schema":{"type":"integer"}}],"responses":{"204":{"description":"No content"},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}}},"tags":["Książka adresowa"],"security":[{"bearer-token-for-user":[]}]}},"/v1/user/payments":{"get":{"operationId":"payments","summary":"Pobieranie listy płatności użytkownika","description":"Metoda służy do zwracania listy z płatnościami użytkownika.","parameters":[{"name":"amountFrom","required":false,"in":"query","description":"Kwota od:","schema":{"format":"decimal","example":10.5,"type":"number"}},{"name":"amountTo","required":false,"in":"query","description":"Kwota do:","schema":{"format":"decimal","example":10.5,"type":"number"}},{"name":"dateFrom","required":false,"in":"query","description":"Data od: w standardzie ISO 8601","schema":{"example":"2024-12-22","type":"string"}},{"name":"dateTo","required":false,"in":"query","description":"Data do: w standardzie ISO 8601","schema":{"example":"2024-12-22","type":"string"}},{"name":"type","required":false,"in":"query","description":"Rodzaj płatności","schema":{"enum":["balance","payment_for_order","payment_for_orders","collective","payment_for_invoice"],"type":"string"}},{"name":"status","required":false,"in":"query","description":"Status płatności","schema":{"enum":["waiting_for_payment","done","rejected","added_to_collective","done_collective","invalid"],"type":"string"}},{"name":"offset","required":false,"in":"query","description":"Offset do paginacji","schema":{"type":"integer"}},{"name":"limit","required":false,"in":"query","description":"Limit zwracanych płatności","schema":{"default":10,"type":"integer"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentsResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}}},"tags":["Płatności"],"security":[{"bearer-token-for-user":[]}]}},"/v1/user/payments/{id}":{"get":{"operationId":"getPayment","summary":"Szczegóły płatności","description":"Metoda służy do zwracania szczegółów dla wybranej płatności.","parameters":[{"name":"id","required":true,"in":"path","description":"Identyfikator płatności w systemie epaka.pl","schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentData"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}}},"tags":["Płatności"],"security":[{"bearer-token-for-user":[]}]},"patch":{"operationId":"changeProviderPayment","summary":"Zmiana operatora dla płatności","description":"Metoda służy do zmiany operatora płatności, przypisanego do wybranej płatności.","parameters":[{"name":"id","required":true,"in":"path","description":"Identyfikator płatności w systemie epaka.pl","schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentQuery"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentData"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}}},"tags":["Płatności"],"security":[{"bearer-token-for-user":[]}]}},"/v1/user/payments/{id}/pay":{"post":{"operationId":"pay","summary":"Tworzenie transakcji w systemie operatora płatności.","description":"Metoda służy do utworzenia transakcji do płatności w systemie wybranego operatora płatności, w celu zwrócenia danych potrzebnych do wykonania płatności. W przypadku płatności z kodem Blik, zwrócony zostanie status płatności.","parameters":[{"name":"id","required":true,"in":"path","description":"Identyfikator płatności w systemie epaka.pl","schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayRequest"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}}},"tags":["Płatności"],"security":[{"bearer-token-for-user":[]}]}},"/v1/user/payments/{id}/status":{"get":{"operationId":"paymentStatus","summary":"Zwracanie statusu płatności","description":"Metoda służy do zwrócenia, aktualnego statusu płatności.","parameters":[{"name":"id","required":true,"in":"path","description":"Identyfikator płatności w systemie epaka.pl","schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentStatusResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}}},"tags":["Płatności"],"security":[{"bearer-token-for-user":[]}]}},"/v1/user/payments/{id}/cancel":{"patch":{"operationId":"cancelCollective","summary":"Anulowanie płatności zbiorczej","description":"Metoda służy do anulowania płatności zbiorczej.","parameters":[{"name":"id","required":true,"in":"path","description":"Identyfikator płatności w systemie epaka.pl","schema":{"type":"integer"}}],"responses":{"204":{"description":"No content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}}},"tags":["Płatności"],"security":[{"bearer-token-for-user":[]}]}},"/v1/user/payments/create-collective":{"post":{"operationId":"createCollective","summary":"Tworzenie płatności zbiorczej","description":"Metoda służy do utworzenia płatności zbiorczej, dla podanych identyfikatorów płatności.","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCollectivePaymentBody"}}}},"responses":{"201":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentData"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}}},"tags":["Płatności"],"security":[{"bearer-token-for-user":[]}]}},"/v1/user/invoices":{"get":{"operationId":"getInvoices","summary":"Lista faktur","description":"Metoda służy do pobierania listy wystawionych faktur dla użytkownika.","parameters":[{"name":"number","required":false,"in":"query","description":"Numer faktury","schema":{"type":"string"}},{"name":"amountFrom","required":false,"in":"query","description":"Kwota netto od:","schema":{"format":"decimal","type":"number"}},{"name":"amountTo","required":false,"in":"query","description":"Kwota netto do:","schema":{"format":"decimal","type":"number"}},{"name":"dateFrom","required":false,"in":"query","description":"Data wystawienia od: w standardzie ISO 8601","schema":{"example":"2024-12-22","type":"string"}},{"name":"dateTo","required":false,"in":"query","description":"Data wystawienia do: w standardzie ISO 8601","schema":{"example":"2024-12-22","type":"string"}},{"name":"paid","required":false,"in":"query","description":"Faktura opłacona","schema":{"type":"boolean"}},{"name":"fastPayment","required":false,"in":"query","description":"Szybka płatność za fakture - do ukrycia","schema":{"type":"boolean"}},{"name":"offset","required":false,"in":"query","description":"Offset do paginacji","schema":{"type":"integer"}},{"name":"limit","required":false,"in":"query","description":"Limit zwracanych zamówień","schema":{"default":10,"type":"integer"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoicesResponse"}}}},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}}},"tags":["Faktury"],"security":[{"bearer-token-for-user":[]}]}},"/v1/user/invoices/{id}":{"get":{"operationId":"getInvoice","summary":"Szczegóły faktury","description":"Metoda służy do pobierania szczegółów dla wybranej faktury.","parameters":[{"name":"id","required":true,"in":"path","description":"Identyfikator faktury w systemie epaka.pl","schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceDetailsResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}}},"tags":["Faktury"],"security":[{"bearer-token-for-user":[]}]}},"/v1/user/invoices/{id}/payment":{"get":{"operationId":"getPaymentForInvoice","summary":"Dane o płatności za fakture","description":"Metoda służy do pobierania danych płatności, przypisanej do faktury.","parameters":[{"name":"id","required":true,"in":"path","description":"Identyfikator faktury w systemie epaka.pl","schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentData"}}}},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}}},"tags":["Faktury"],"security":[{"bearer-token-for-user":[]}]},"patch":{"operationId":"changePaymentProviderForInvoice","summary":"Zmiana operatora płatności","description":"Metoda służy do zmiany operatora płatności przypisanego do faktury.","parameters":[{"name":"id","required":true,"in":"path","description":"Identyfikator faktury w systemie epaka.pl","schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentQuery"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentData"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}}},"tags":["Faktury"],"security":[{"bearer-token-for-user":[]}]}},"/v1/user/invoices/{id}/invoice":{"get":{"operationId":"getInvoiceUrl","summary":"Pobieranie faktury","description":"Metoda zwraca link do pobrania faktury z systemu epaka.pl","parameters":[{"name":"id","required":true,"in":"path","description":"Identyfikator faktury w systemie epaka.pl","schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceUrl"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}}},"tags":["Faktury"],"security":[{"bearer-token-for-user":[]}]}},"/v1/user/invoices/create-collective":{"post":{"operationId":"createCollectiveForInvoices","summary":"Płatność zbiorcza dla faktury","description":"Metoda służy do utworzenia płatności zbiorczej, dla podanych identyfikatorów faktur.","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceCreateCollectivePaymentBody"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentData"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}}},"tags":["Faktury"],"security":[{"bearer-token-for-user":[]}]}},"/v1/invoices":{"get":{"operationId":"ordersByIds","summary":"Lista faktur po id","description":"Metoda służy do pobrania listy faktur po podanych id.","parameters":[{"name":"ids","required":true,"in":"query","description":"Lista identyfikatorów faktur w systemie epaka.pl","schema":{"example":[1,2,3],"type":"array","items":{"type":"number"}}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoicesFullResponse"}}}}},"security":[{"bearer-token-for-service":[]}]}},"/v1/user/cart":{"get":{"operationId":"cart","summary":"Zawartość koszyka","description":"Metoda służy do pobrania zawartości koszyka.","parameters":[],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CartResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}}},"tags":["Koszyk"],"security":[{"bearer-token-for-user":[]}]},"post":{"operationId":"addCartItem","summary":"Dodanie do koszyka","description":"Metoda służy do dodania płatności lub zamówień do koszyka.","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddToCartPayload"}}}},"responses":{"204":{"description":"No content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}}},"tags":["Koszyk"],"security":[{"bearer-token-for-user":[]}]}},"/v1/user/cart/{ids}":{"delete":{"operationId":"deleteNotification","summary":"Usuwanie z koszyka.","description":"Metoda służy do usuwania płatności z koszyka.","parameters":[{"name":"ids","required":true,"in":"path","description":"Identyfikatory płatności do usunięcia z koszyka.","schema":{"example":"111,112,113","type":"integer"}}],"responses":{"204":{"description":"No content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}}},"tags":["Koszyk"],"security":[{"bearer-token-for-user":[]}]}},"/v1/user/cart/payment":{"get":{"operationId":"paymentDataForCart","summary":"Pobieranie danych do płatności za koszyk","description":"Metoda służy do stworzenia płatności zbiorczej, dla pozycji dodanych do koszyka. Zwraca dane utworzonej płatności zbiorczej, potrzebne do kolejnego kroku płatności.","parameters":[],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentData"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}}},"tags":["Koszyk"],"security":[{"bearer-token-for-user":[]}]}},"/v1/user/templates":{"get":{"operationId":"orders","summary":"Szablony","description":"Metoda służy do zwracania listy szablonów.","parameters":[{"name":"query","required":false,"in":"query","description":"Tekst do do wyszukania w szablonie","schema":{"type":"string"}},{"name":"id","required":false,"in":"query","description":"Identyfikator szablonu","schema":{"type":"integer"}},{"name":"courierId","required":false,"in":"query","description":"Identyfikator kuriera","schema":{"type":"integer"}},{"name":"shippingType","required":false,"in":"query","description":"Rodzaj wysyłki:
envelope - Koperta
package - Paczka
pallet - Paleta
tires - Opony
","schema":{"enum":["envelope","package","pallet","tires"],"type":"string"}},{"name":"offset","required":false,"in":"query","description":"Offset do paginacji","schema":{"type":"integer"}},{"name":"limit","required":false,"in":"query","description":"Limit zwracanych płatności","schema":{"default":10,"type":"integer"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemplatesResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}}},"tags":["Szablony"],"security":[{"bearer-token-for-user":[]}]},"post":{"operationId":"createAddress","summary":"Dodawanie nowego szablonu","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemplatePayload"}}}},"responses":{"204":{"description":"No content"},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}}},"tags":["Szablony"],"security":[{"bearer-token-for-user":[]}]}},"/v1/user/templates/{id}":{"get":{"operationId":"orderDetails","summary":"Szczegóły szablonu","description":"Metoda służy do pobierania szczegółów wybranego szablonu.","parameters":[{"name":"id","required":true,"in":"path","description":"Identyfikator szablonu.","schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemplateResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}}},"tags":["Szablony"],"security":[{"bearer-token-for-user":[]}]},"put":{"operationId":"editAddress","summary":"Edycja szablonu","parameters":[{"name":"id","required":true,"in":"path","description":"Identyfikator szablonu.","schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemplatePayload"}}}},"responses":{"204":{"description":"No content"},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}}},"tags":["Szablony"],"security":[{"bearer-token-for-user":[]}]},"delete":{"operationId":"deleteAddress","summary":"Usuwanie szablonu","parameters":[{"name":"id","required":true,"in":"path","description":"Identyfikator szablonu.","schema":{"type":"integer"}}],"responses":{"204":{"description":"No content"},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}}},"tags":["Szablony"],"security":[{"bearer-token-for-user":[]}]},"patch":{"operationId":"notificationRead","summary":"Ustawienie szablonu jako domyślnego.","parameters":[{"name":"id","required":true,"in":"path","description":"Identyfikatory powiadomień w systemie epaka.pl","schema":{"type":"integer"}}],"responses":{"204":{"description":"No content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}}},"tags":["Szablony"],"security":[{"bearer-token-for-user":[]}]}},"/v1/couriers":{"get":{"operationId":"couriers","summary":"Lista kurierów","description":"Metoda służy do pobrania listy dostępnych kurierów.","parameters":[{"name":"deliveryType","required":false,"in":"query","description":"Rodzaj doręczenia przesyłki","schema":{"nullable":true,"enum":["door","point"],"type":"string"}},{"name":"receiverType","required":false,"in":"query","description":"Rodzaj nadania przesyłki","schema":{"nullable":true,"enum":["door","point"],"type":"string"}},{"name":"points","required":false,"in":"query","description":"Kurier posiada własne punkty","schema":{"nullable":true,"type":"boolean"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CouriersResponse"}}}}},"tags":["Kurierzy"]}},"/v1/couriers/{id}":{"get":{"operationId":"courier","summary":"Kurier","description":"Metoda służy do pobrania danych wybranego kuriera.","parameters":[{"name":"id","required":true,"in":"path","description":"Identyfikator kuriera w systemie epaka.pl","schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CourierData"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}}},"tags":["Kurierzy"]}},"/v1/countries":{"get":{"operationId":"countries","summary":"Lista krajów","description":"Metoda służy do pobrania listy krajów.","parameters":[],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CountriesResponse"}}}}},"tags":["Kraje"]}},"/v1/countries/{code}":{"get":{"operationId":"courier","summary":"Kraj po kodzie","description":"Metoda służy do pobrania szczegółów kraju po kodzie np. \"PL\"","parameters":[{"name":"code","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CountryData"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}}},"tags":["Kraje"]}},"/v1/tracking":{"get":{"operationId":"tracking","summary":"Statusy kurierskie przesyłki","description":"Metoda służy do zwracania listy statusów kurierskich dla podanego numeru listu przewozowego.","parameters":[{"name":"labelNumber","required":true,"in":"query","description":"Numer listu przewozowego","schema":{"type":"string"}},{"name":"courierId","required":false,"in":"query","description":"Id kuriera","schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TrackingDetailsResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}}},"tags":["Tracking"]}},"/v1/points":{"get":{"operationId":"getPoints","summary":"Pobieranie listy punktów według podanych parametrów","description":"Metoda służy do zwracania listy punktów, które w zależności od wybranych parametrów wyszukiwania, służą do nadania lub odbioru przesyłki.","parameters":[{"name":"limit","required":false,"in":"query","description":"Limit do ilości zwracanych punktów","schema":{"nullable":true,"default":100,"type":"integer"}},{"name":"query","required":false,"in":"query","description":"Tekst do szukania(miasto, ID punktu)","schema":{"nullable":true,"type":"string"}},{"name":"pointFunction","required":false,"in":"query","description":"Funkcja punktu","schema":{"nullable":true,"default":"all","enum":["sender","receiver","all"],"type":"string"}},{"name":"pointType","required":false,"in":"query","description":"Rodzaj punktu","schema":{"nullable":true,"default":"all","enum":["machine","pop","all"],"type":"string"}},{"name":"couriers","required":false,"in":"query","description":"Id kurierów dla których mają zostać zwrócone punkty","schema":{"nullable":true,"default":[0],"type":"array","items":{"type":"integer"}}},{"name":"cod","required":false,"in":"query","description":"Dostępność usługi Pobrania","schema":{"nullable":true,"type":"boolean"}},{"name":"codValue","required":false,"in":"query","description":"Wartość pobrania (tylko dla usługi zwrotu pobrania w punkcie epaka.pl)","schema":{"nullable":true,"type":"number"}},{"name":"lat","required":false,"in":"query","description":"Latitude","schema":{"nullable":true,"type":"string"}},{"name":"lon","required":false,"in":"query","description":"Longitude","schema":{"nullable":true,"type":"string"}},{"name":"city","required":false,"in":"query","description":"Miasto","schema":{"nullable":true,"example":"Łuków","type":"string"}},{"name":"postCode","required":false,"in":"query","description":"Kod pocztowy","schema":{"nullable":true,"example":"21-400","type":"string"}},{"required":false,"description":"Waga","name":"weight","in":"query","schema":{"format":"decimal","nullable":true,"type":"number"}},{"required":false,"description":"Wysokość","name":"height","in":"query","schema":{"format":"decimal","nullable":true,"type":"number"}},{"required":false,"description":"Szerokość","name":"width","in":"query","schema":{"format":"decimal","nullable":true,"type":"number"}},{"required":false,"description":"Długość","name":"length","in":"query","schema":{"format":"decimal","nullable":true,"type":"number"}},{"name":"country","required":false,"in":"query","description":"Kod kraju (wynagane dla kuriera InPost Int)","schema":{"nullable":true,"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PointsResponse"}}}}},"tags":["Punkty nadań/obioru"]}},"/v1/points/epaka":{"get":{"operationId":"ordersByIds","summary":"Lista punktów po id","description":"Metoda służy do pobrania listy punktów po podanych id.","parameters":[{"name":"ids","required":true,"in":"query","description":"Lista identyfikatorów punktów w systemie epaka.pl","schema":{"example":[1,2,3],"type":"array","items":{"type":"number"}}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PointsFullResponse"}}}}},"tags":["Punkty nadań/obioru"],"security":[{"bearer-token-for-service":[]}]}},"/v1/order/content/check":{"post":{"operationId":"checkContent","summary":"Sprawdzenie zawartości","description":"Metoda służy do sprawdzenia zawartości i ewentualnym zwróceniu dodatkowych informacji do wyświetlenia użytkownikowi.","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckContentPayload"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckContentResponse"}}}},"204":{"description":"No content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}}},"tags":["Zamów kuriera"]}},"/v1/order/shipping-type":{"get":{"operationId":"shippingType","summary":"Rodzaj wysyłki","description":"Metoda służy do pobieranie listy dostępnych rodzajów wysyłki.","parameters":[],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShippingTypesResponse"}}}}},"tags":["Zamów kuriera"]}},"/v1/order/package-type":{"get":{"operationId":"packageType","summary":"Rodzaje opakowania","description":"Metoda służy do pobierania listy z rodzajami opakowania dla wybranego typu wysyłki.","parameters":[{"name":"shippingType","required":false,"in":"query","description":"Type wysyłki:
envelope - Koperta
package - Paczka
pallet - Paleta
","schema":{"default":"envelope","enum":["envelope","package","pallet"],"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PackageTypesResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}}},"tags":["Zamów kuriera"]}},"/v1/order/prices":{"post":{"operationId":"prices","summary":"Wycena kurierów","description":"Metoda służy do wykonania, wstępnej wyceny przesyłki, dla podanych parametrów przesyłki. Zwraca listę dostępnych kurierów, wraz z cenami.","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PricesPayload"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PricesResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}}},"tags":["Zamów kuriera"],"security":[{"bearer-token-for-user":[]}]}},"/v1/order/pickup-date":{"get":{"operationId":"pickupDate","summary":"Dni nadania","description":"Metoda służy do pobrania listy dostępnych dni nadania, dla wybranego kuriera.","parameters":[{"name":"couriers","required":false,"in":"query","description":"Id kurierów.","schema":{"type":"array","items":{"type":"integer"}}},{"name":"postCode","required":false,"in":"query","description":"Kod pocztowy nadawcy","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PickupDateResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}}},"tags":["Zamów kuriera"]}},"/v1/order/pickup-hours":{"get":{"operationId":"pickupHours","summary":"Godziny nadania","description":"Metoda służy do pobrania godzin nadania przesyłki, dla wybranego kuriera oraz dnia.","parameters":[{"name":"courierId","required":true,"in":"query","description":"Id kuriera","schema":{"type":"integer"}},{"name":"postCode","required":true,"in":"query","description":"Kod pocztowy nadawcy","schema":{"type":"string"}},{"name":"senderCountry","required":true,"in":"query","description":"Kod kraj nadawcy","schema":{"example":"PL","type":"string"}},{"name":"date","required":true,"in":"query","description":"Data nadania w standardzie ISO 8601","schema":{"example":"2024-10-20","type":"string"}},{"name":"weight","required":false,"in":"query","description":"Parametr dostępny dla kuriera UPS
Łączna waga przesyłki","schema":{"format":"decimal","type":"number"}},{"name":"packagesNumber","required":false,"in":"query","description":"Parametr dostępny dla kuriera UPS
Liczba opakowań","schema":{"type":"number"}},{"name":"serviceType","required":false,"in":"query","description":"Parametr dostępny dla kuriera UPS
Rodzaj serwisu:
UPS Standard (usługa drogowa)
UPS Express Saver
UPS Express (doręczenie do godz. 12)
UPS Express Plus (doręczenie do godz. 9)","schema":{"enum":["UPS Standard","UPS Express Saver","UPS Express","UPS Express Plus"],"type":"string"}},{"name":"type","required":false,"in":"query","description":"Parametr dostępny dla kuriera DHL
Typ przesyłki:
ex – paczki do 31,5 kg i koperty
dr – paczki powyżej 31,5 kg i palety
express - dla DHL Express","schema":{"enum":["ex","dr","express"],"type":"string"}},{"name":"label","required":false,"in":"query","description":"Parametr dostępny dla kuriera DPD
Etykieta:
false - Etykietę drukuję nadawca
true - Etykietę przywiezie kurier","schema":{"default":false,"type":"boolean"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PickupHoursResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}}},"tags":["Zamów kuriera"]}},"/v1/order/services":{"get":{"operationId":"services","summary":"Usługi dodatkowe","description":"Metoda służy do pobrania usług dodatkowych, dla podanych parametrów przesyłki.","parameters":[{"name":"courierId","required":false,"in":"query","description":"Id kuriera (opcjonalne)","schema":{"type":"integer"}},{"name":"shippingType","required":true,"in":"query","description":"Rodzaj wysyłki:
envelope - Koperta
package - Paczka
pallet - Paleta
tires - Opony
","schema":{"enum":["envelope","package","pallet","tires"],"type":"string"}},{"name":"senderCountry","required":true,"in":"query","description":"Kraj nadania","schema":{"example":"PL","type":"string"}},{"name":"receiverCountry","required":true,"in":"query","description":"Kraj odbioru","schema":{"example":"PL","type":"string"}},{"name":"senderPostCode","required":false,"in":"query","description":"Kod pocztowy nadawcy (opcjonalne)","schema":{"example":"21-400","type":"string"}},{"name":"receiverPostCode","required":false,"in":"query","description":"Kod pocztowy odbiorcy (opcjonalne)","schema":{"example":"21-400","type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServicesResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}}},"tags":["Zamów kuriera"],"security":[{"bearer-token-for-user":[]}]}},"/v1/order/services/cod/prices":{"get":{"operationId":"codPrices","summary":"Wycena usługi pobrania","description":"Metoda służy do wyceny usługi pobrania, dla podanej wartości.","parameters":[{"name":"courierId","required":true,"in":"query","description":"Id kuriera","schema":{"type":"integer"}},{"name":"codAmount","required":true,"in":"query","description":"Wartość pobrania","schema":{"format":"decimal","type":"number"}},{"name":"codReturnType","required":false,"in":"query","description":"Rodzaj pobrania:
account - Zwrot pobrania na konto bankowe lub saldo
cash - Zwrot pobrania w punkcie epaka.pl
","schema":{"default":"account","enum":["account","cash"],"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CodPricesResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}}},"tags":["Zamów kuriera"],"security":[{"bearer-token-for-user":[]}]}},"/v1/order/services/cod":{"get":{"operationId":"codTypes","summary":"Rodzaję pobrania","description":"Metoda służy do pobrania listy dostępnych rodzajów pobrania, dla użytkownika.","parameters":[{"name":"courierId","required":true,"in":"query","description":"Id kuriera","schema":{"type":"integer"}},{"name":"returnType","required":false,"in":"query","description":"Rodzaj pobrania:
account - Zwrot pobrania na konto bankowe lub saldo
cash - Zwrot pobrania w punkcie epaka.pl
","schema":{"default":"account","enum":["account","cash"],"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CodTypesResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}}},"tags":["Zamów kuriera"],"security":[{"bearer-token-for-user":[]}]}},"/v1/order/services/insurance/price":{"get":{"operationId":"insurancePrice","summary":"Wycena usługi ubezpieczenia","description":"Metoda służy do wyceny usługi ubezpieczenia, dla podanej kwoty ubezpieczenia.","parameters":[{"name":"courierId","required":true,"in":"query","description":"Id kuriera","schema":{"type":"integer"}},{"name":"declaredValue","required":true,"in":"query","description":"Wartość ubezpieczenia","schema":{"format":"decimal","type":"number"}},{"name":"maxWeight","required":false,"in":"query","description":"Maksymalna waga przesyłek (DHL)","schema":{"format":"decimal","type":"number"}},{"name":"senderCountry","required":false,"in":"query","description":"Kraj nadania","schema":{"default":"PL","example":"PL","type":"string"}},{"name":"receiverCountry","required":false,"in":"query","description":"Kraj odbioru","schema":{"default":"PL","example":"PL","type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InsurancePriceResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}}},"tags":["Zamów kuriera"],"security":[{"bearer-token-for-user":[]}]}},"/v1/order/search-item-code":{"get":{"operationId":"searchItemCode","summary":"Kody produktów","description":"Metoda służy do wyszukiwania kodów dla produktów.","parameters":[{"name":"text","required":true,"in":"query","description":"Nazwa przedmiotu lub kod","schema":{"type":"string"}},{"name":"limit","required":false,"in":"query","description":"Limit zwracanych danych","schema":{"default":10,"type":"integer"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchItemCodeResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}}},"tags":["Zamów kuriera"]}},"/v1/order/cities":{"get":{"operationId":"getCities","summary":"Miasta (PL)","description":"Metoda służy do zwracania listy miast po kodzie pocztowym.","parameters":[{"name":"postCode","required":true,"in":"query","description":"Kod pocztowy","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CitiesResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}}},"tags":["Zamów kuriera"],"security":[{"bearer-token-for-user":[]}]}},"/v1/order/streets":{"get":{"operationId":"getStreets","summary":"Zwraca listę ulica dla wybranego miasta i kodu pocztowego","description":"Metoda służy do zwracania listy ulic po wybranym mieście i kodzie pocztowym.","parameters":[{"name":"postCode","required":true,"in":"query","description":"Kod pocztowy","schema":{"example":"21-400","type":"string"}},{"name":"city","required":true,"in":"query","description":"Miasto","schema":{"example":"Łuków","type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StreetsResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}}},"tags":["Zamów kuriera"],"security":[{"bearer-token-for-user":[]}]}},"/v1/order/post-code":{"get":{"operationId":"checkPostCode","summary":"Kod pocztowy (PL)","description":"Metoda służy do sprawdzenia, czy podany kod pocztowy istnieje.","parameters":[{"name":"postCode","required":true,"in":"query","description":"Kod pocztowy (PL)","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostCodeResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}}},"tags":["Zamów kuriera"],"security":[{"bearer-token-for-user":[]}]}},"/v1/order/check-data":{"post":{"operationId":"checkData","summary":"Sprawdzenie danych/wycena","description":"Metoda służy do sprawdzenia poprawności wprowadzonych danych zamówienia, w celu zwrócenia wyceny przesyłki wraz cenami usług dodatkowych.","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderBody"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckDataResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}}},"tags":["Zamów kuriera"],"security":[{"bearer-token-for-user":[]}]}},"/v1/order":{"post":{"operationId":"makeOrder","summary":"Składanie zamówienia","description":"Metoda służy do złożenia zamówienia w systemie epaka.pl","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderBody"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}}},"tags":["Zamów kuriera"],"security":[{"bearer-token-for-user":[]}]}},"/v1/order/{id}/add-package-photos":{"post":{"operationId":"addPhotoFilesToOrder","summary":"Dodawanie zdjęc do złożonego zamówienia","description":"Metoda umożliwia przesłanie 5 zdjęc dokumentujących parametry przesyłki: Dodaj zdjęcia dokumentujące parametry przesyłki:
  1. Zdjęcia z taśmą mierniczą na każdym boku i wskazaniem wyniku pomiaru.
  2. Zdjęcia kształtu całej przesyłki i formy jej opakowania.
  3. Zdjęcia na wadze ze wskazaniem wyniku pomiaru(powinna być to waga legalizowana)

Możliwe jest przesłanie maksymalnie 5 zdjęć w formacie .png lub .jpg w rozmiarze do 5MB każde.
WAŻNE: Zdjęcia mogą posłużyć jako dowód w sprawie przy ewentualnej reklamacji u przewoźnika. Firma epaka.pl S.A. nie odpowiada za skutek prawny i stanowisko przewoźnika.

WAŻNE. Możliwe jest jednorazowe wykonanie endpointu w ciągu 24 godzin od złożenia zamówienia.","parameters":[{"name":"id","required":true,"in":"path","description":"Identyfikator zamówienia w systemie epaka.pl","schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/ImagesPayload"}}}},"responses":{"204":{"description":"No content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}}},"tags":["Zamów kuriera"],"security":[{"bearer-token-for-user":[]}]}},"/v1/order/add-files":{"post":{"operationId":"addFilesToOrder","summary":"Dodawanie plików do złożonego zamówienia","description":"Metoda umożliwia przesłanie plików do złozonego zamówienia, takich jak :.
  1. Faktura (Obsługa Celna).
  2. Dokumenty potrzebne do obługi celnej.

","parameters":[],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/CustomsServiceFilesPayload"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddFilesResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}}},"tags":["Zamów kuriera"],"security":[{"bearer-token-for-user":[]}]}},"/v1/freight-order":{"post":{"operationId":"createFreightOrder","summary":"Wycena indywidualna.","description":"Metoda służy do złożenia zamówienia spedycyjnego w systemie epaka.pl","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FreightOrderPayload"}}}},"responses":{"204":{"description":"No content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}}},"tags":["Wycena indywidualna"],"security":[{"bearer-token-for-user":[]}]}},"/v1/payment/{token}":{"get":{"operationId":"getPayment","summary":"Szczegóły płatności","description":"Metoda służy do zwracania szczegółów dla wybranej płatności.","parameters":[{"name":"token","required":true,"in":"path","description":"Unikalny token płatności w systemie epaka.pl","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentData"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}}},"security":[{"bearer-token-for-user":[]}]},"patch":{"operationId":"changeProviderPayment","summary":"Zmiana operatora dla płatności","description":"Metoda służy do zmiany operatora płatności, przypisanego do wybranej płatności.","parameters":[{"name":"token","required":true,"in":"path","description":"Unikalny token płatności w systemie epaka.pl","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentQuery"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentData"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}}},"security":[{"bearer-token-for-user":[]}]}},"/v1/payment/{token}/status":{"get":{"operationId":"paymentStatus","summary":"Zwracanie statusu płatności","description":"Metoda służy do zwrócenia, aktualnego statusu płatności.","parameters":[{"name":"token","required":true,"in":"path","schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"Unikalny token płatności w systemie epaka.pl","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentStatusResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponse"}}}}},"security":[{"bearer-token-for-user":[]}]}},"/v1/franchises":{"get":{"operationId":"ordersByIds","summary":"Lista franczyz po id","description":"Metoda służy do pobrania listy franczyz po podanych id.","parameters":[{"name":"ids","required":true,"in":"query","description":"Lista identyfikatorów franczyz w systemie epaka.pl","schema":{"example":[1,2,3],"type":"array","items":{"type":"number"}}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FranchisesResponse"}}}}},"tags":["Franczyzy"],"security":[{"bearer-token-for-service":[]}]}},"/v1/accounting-invoice/point/{pointId}/invoice/{documentId}":{"get":{"operationId":"getInvoiceForDocument","summary":"Pobieranie danych faktury","description":"Pobiera dane faktury dla danego dokumentu i punktu.","parameters":[{"name":"pointId","required":true,"in":"path","schema":{"type":"number"}},{"name":"documentId","required":true,"in":"path","schema":{"type":"number"}}],"responses":{"200":{"description":"Dane faktury zostały pomyślnie pobrane.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceDataResponseDto"}}}}},"tags":["Faktury"],"security":[{"bearer-token-for-service":[]}]},"post":{"operationId":"sendInvoiceDetails","summary":"Przesyłanie szczegółów faktury z inFakt","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InfaktInvoiceDto"}}}},"responses":{"200":{"description":"Szczegóły faktury zostały pomyślnie przesłane."}},"tags":["Faktury"],"security":[{"bearer-token-for-service":[]}]}},"/v1/accounting-invoice/point/{pointId}/invoice/{documentId}/status":{"patch":{"operationId":"updateInvoiceStatus","summary":"Aktualizacja statusu faktury w Infakt","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateStatusInfaktDto"}}}},"responses":{"200":{"description":"Status faktury został zaktualizowany."}},"tags":["Faktury"],"security":[{"bearer-token-for-service":[]}]}},"/v1/accounting-invoice/invoice-pdf":{"post":{"operationId":"sendInvoicePdf","summary":"Przesyłanie pliku PDF faktury z inFakt","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoicePdfDto"}}}},"responses":{"200":{"description":"Plik PDF faktury został pomyślnie przesłany."}},"tags":["Faktury"],"security":[{"bearer-token-for-service":[]}]}},"/v1/accounting-invoice/point/{pointId}/corrective-invoice/{documentId}":{"post":{"operationId":"sendCorrectiveInvoiceDetails","summary":"Przesyłanie szczegółów faktury korygującej z inFakt","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InfaktCorrectiveInvoiceDto"}}}},"responses":{"200":{"description":"Szczegóły faktury korygującej zostały pomyślnie przesłane."}},"tags":["Faktury"],"security":[{"bearer-token-for-service":[]}]}},"/v1/accounting-invoice/point/{pointId}/invoice/resend":{"post":{"operationId":"prepareInvoicesForResendProcess","summary":"Przygotowywanie faktur do ponownego wysłania do InFakt","parameters":[],"responses":{"200":{"description":"Faktury zostały przygotowane do ponownego wysłania."}},"tags":["Faktury"],"security":[{"bearer-token-for-service":[]}]}}},"info":{"title":"epaka.pl REST API","description":"","version":"latest","contact":{"name":"Bok","url":"https://epaka.pl/kontakt","email":"bok@epaka.pl"},"x-logo":{"url":"https://epaka.pl/img/logo_120px.png","backgroundColor":"#fafafa","altText":"LOGO"}},"tags":[{"name":"Dokumentacja WebAPI(XML)","description":"Dokumentacja do poprzedniej wersji API (XML) w formacie PDF dostępna jest tutaj."},{"name":"Zamów kuriera","description":"Zbiór metod służących do złożenia zamówienia."},{"name":"Punkty nadań/obioru","description":"Zbiór metod do pobierania punktów kurierskich."},{"name":"Kraje","description":"Zbiór metod do pobierania krajów."},{"name":"Kurierzy","description":"Metody do pobierania danych o kurierach."},{"name":"Koszyk","description":"Zbiór metod do obsługi koszyka."},{"name":"Autoryzacja","description":"Autoryzacja w api, odbywa się za pomocą tokenu autoryzacyjnego, przekazanego w nagłówku Authorization.\n Autoryzacja użytkownika następuję według standardu OAuth2. "},{"name":"Profil","description":"Zbiór metod do zarządzania danymi profilu."},{"name":"Szablony","description":"Zbiór metod do obsługi szablonów."},{"name":"Płatności","description":"Zbiór metod do obsługi płatności."},{"name":"Faktury","description":"Zbiór metod do obsługi faktur."},{"name":"Zamówienia","description":"Zbiór metod umożliwiających zarządzanie już złożonymi zamówieniami."},{"name":"Książka adresowa","description":"Zbiór metod do obsługi książki adresowej."}],"servers":[{"url":"https://api.epaka.pl","description":"Serwer produkcyjny"}],"components":{"securitySchemes":{"bearer-token-for-user":{"type":"oauth2","flows":{"authorizationCode":{"scopes":[],"authorizationUrl":"https://epaka.pl/oauth/authorize","tokenUrl":"https://epaka.pl/oauth/token"}},"description":"Dokumentacja OAuth2","name":"bearer-token-for-user","bearerFormat":"Bearer","scheme":"Bearer","in":"Header"}},"schemas":{"AddressData":{"type":"object","properties":{"name":{"type":"string","description":"Imię","minLength":2,"maxLength":50,"nullable":true},"lastName":{"type":"string","description":"Nazwisko","minLength":2,"maxLength":100,"nullable":true},"company":{"type":"string","description":"Firma","minLength":4,"maxLength":200,"nullable":true,"example":"epaka.pl"},"country":{"type":"string","default":"PL","description":"Kraj","minLength":2,"maxLength":2,"nullable":true},"street":{"type":"string","description":"Ulica","maxLength":60,"nullable":true,"example":"Sochacz"},"houseNumber":{"type":"string","description":"Numer domu","maxLength":7,"nullable":true,"example":"15"},"flatNumber":{"type":"string","description":"Numer lokalu","maxLength":6,"nullable":true},"postCode":{"type":"string","description":"Kod pocztowy","maxLength":10,"example":"21-400"},"city":{"type":"string","description":"Miasto","maxLength":50,"example":"Łuków"},"phone":{"type":"string","description":"Telefon","minLength":9,"maxLength":15,"example":"123456789"}}},"InvoiceAddressData":{"type":"object","properties":{"name":{"type":"string","description":"Imię","minLength":2,"maxLength":50,"nullable":true},"lastName":{"type":"string","description":"Nazwisko","minLength":2,"maxLength":100,"nullable":true},"company":{"type":"string","description":"Firma","minLength":4,"maxLength":200,"nullable":true,"example":"epaka.pl"},"country":{"type":"string","default":"PL","description":"Kraj","minLength":2,"maxLength":2,"nullable":true},"street":{"type":"string","description":"Ulica","maxLength":60,"nullable":true,"example":"Sochacz"},"houseNumber":{"type":"string","description":"Numer domu","maxLength":7,"nullable":true,"example":"15"},"flatNumber":{"type":"string","description":"Numer lokalu","maxLength":6,"nullable":true},"postCode":{"type":"string","description":"Kod pocztowy","maxLength":10,"example":"21-400"},"city":{"type":"string","description":"Miasto","maxLength":50,"example":"Łuków"},"phone":{"type":"string","description":"Telefon","minLength":9,"maxLength":15,"example":"123456789"},"email":{"type":"string","description":"E-mail dla faktur","nullable":true}}},"PointDataShort":{"type":"object","properties":{"courierId":{"type":"integer","description":"Identyfikator kuriera"},"id":{"type":"integer","description":"Identyfikator punktu"},"name":{"type":"string","description":"Opis punktu"}}},"ProfileData":{"type":"object","properties":{"email":{"type":"string","description":"E-mail użytkownika","readOnly":true},"senderData":{"description":"Dane adresowe użytkownika","allOf":[{"$ref":"#/components/schemas/AddressData"}]},"invoiceData":{"description":"Dane adresowe do faktury","allOf":[{"$ref":"#/components/schemas/InvoiceAddressData"}]},"nip":{"type":"string","description":"Nip firmy","nullable":true},"bankAccount":{"type":"string","description":"Numer konta bankowego","nullable":true,"example":"12345678901234567890123456"},"invoice":{"type":"string","description":"Kiedy wystawiane będą faktury","enum":["no_invoices","after_payment","one_in_month"]},"newsletter":{"type":"boolean","description":"Użytkownik zapisany do newslettera"},"zebra":{"type":"boolean","description":"Użytkownik ma włączone etykiety zebra","readOnly":true},"paymentType":{"type":"string","description":"Rodzaj rozliczania się klienta","enum":["gotówkowy","abonamentowy"],"readOnly":true},"defaultPoints":{"description":"Lista domyślnych punktów nadania, dla wybranych kurierów(InPost Paczkomaty, Orlen Paczka, Paczka48, GLS)","type":"array","items":{"$ref":"#/components/schemas/PointDataShort"}}}},"Error":{"type":"object","properties":{"field":{"type":"string","nullable":true,"description":"Wskazuje pole, którego dotyczy błąd"},"message":{"type":"string","description":"Treść błędu"}}},"BadRequestResponse":{"type":"object","properties":{"errors":{"description":"Lista błędów.","type":"array","items":{"$ref":"#/components/schemas/Error"}},"code":{"type":"integer","description":"Kod błędu."}}},"ErrorApiResponse":{"type":"object","properties":{"error":{"type":"string","description":"Treść błędu."},"message":{"type":"string","description":"Wiadomość do błędu."},"code":{"type":"integer","description":"Kod błędu."}}},"EmployeeResponse":{"type":"object","properties":{"firstName":{"type":"string","description":"Imię pracownika"},"lastName":{"type":"string","description":"Nazwa pracownika"},"phone":{"type":"string","description":"Numer telefonu pracownika"},"email":{"type":"string","description":"Adres email pracownika"}}},"BalanceResponse":{"type":"object","properties":{"balance":{"type":"number","description":"Wartość salda","format":"decimal"}}}," test":{"type":"string","description":"operatora płatności, Domyślnie p24 - Przelewy24","default":"p24","enum":["p24","blik","paypal","credit_card"]},"AddCreditDataPayload":{"type":"object","properties":{"blikCode":{"type":"string","description":"Kod blik. Wymagany gdy operator płatności `blik`"},"regulationAccept":{"type":"boolean","description":"Akceptacja regulaminu operatora płatności","default":false},"amount":{"type":"number","description":"Wartość doładowania","format":"decimal"},"provider":{"$ref":"#/components/schemas/ test"}},"required":["amount"]},"PayResponse":{"type":"object","properties":{"id":{"type":"integer","description":"Identyfikator płatności"},"token":{"type":"string","description":"Token do płatności (Przelewy24)"},"provider":{"type":"string","description":"Operator płatności","enum":["p24","blik","paypal"]},"url":{"type":"string","description":"Adres do wykonania płatności"},"status":{"type":"string","description":"Status płatności","enum":["success","in_progress","error"]}}},"InvoiceReceiverData":{"type":"object","properties":{"name":{"type":"string","description":"Imię","minLength":2,"maxLength":50,"nullable":true},"lastName":{"type":"string","description":"Nazwisko","minLength":2,"maxLength":100,"nullable":true},"company":{"type":"string","description":"Nazwa firmy.
Jest wymagane jeżeli nie są podane pola \"Imie\" i \"Nazwisko\", albo jak jest podany \"nip\".","minLength":4,"maxLength":200,"nullable":true,"example":"epaka.pl"},"country":{"type":"string","default":"PL","description":"Kraj","minLength":2,"maxLength":2,"nullable":true},"city":{"type":"string","description":"Miasto","maxLength":50,"example":"Łuków"},"street":{"type":"string","description":"Ulica","maxLength":60,"nullable":true,"example":"Sochacz"},"houseNumber":{"type":"string","description":"Numer domu","maxLength":7,"nullable":true,"example":"15"},"flatNumber":{"type":"string","description":"Numer lokalu","maxLength":6,"nullable":true},"postCode":{"type":"string","description":"Kod pocztowy","maxLength":10,"example":"21-400"},"nip":{"type":"string","description":"Nip firmy.
Jest wymagane jeżeli podano nazwę firmy.","nullable":true}},"required":["country","city","street","houseNumber","postCode"]},"User":{"type":"object","properties":{}},"UsersResponse":{"type":"object","properties":{"users":{"description":"Lista użytkowników","type":"array","items":{"$ref":"#/components/schemas/User"}}}},"ShortCourierData":{"type":"object","properties":{"id":{"type":"integer","description":"Identyfikator kuriera"},"name":{"type":"string","description":"Nazwa kuriera"},"logo":{"type":"string","description":"Logo kuriera"}}},"PackageStatusData":{"type":"object","properties":{"id":{"type":"integer","description":"Identyfikator statusu"},"name":{"type":"string","description":"Nazwa statusu"}}},"Order":{"type":"object","properties":{"id":{"type":"integer","description":"Identyfikator zamówienia"},"date":{"format":"date-time","type":"string","description":"Data złożenia zamówienia"},"receiverName":{"type":"string","description":"Imię odbiorcy"},"receiverLastName":{"type":"string","description":"Nazwisko odbiorcy"},"receiverCompany":{"type":"string","nullable":true,"description":"Nazwa firmy odbiorcy"},"receiverEmail":{"type":"string","nullable":true,"description":"Adres email odbiorcy"},"status":{"type":"string","description":"Status zamówienia w systemie epaka.pl"},"labelNumber":{"type":"string","nullable":true,"description":"Numer listu przewozowego"},"courier":{"$ref":"#/components/schemas/ShortCourierData"},"packageStatus":{"description":"Status przesyłki","nullable":true,"allOf":[{"$ref":"#/components/schemas/PackageStatusData"}]}}},"OrderListResponse":{"type":"object","properties":{"orders":{"description":"Lista zamówień użytkownika","type":"array","items":{"$ref":"#/components/schemas/Order"}},"count":{"type":"integer","description":"Liczba wszystkich dostępnych zamówień."}}},"OrderSenderData":{"type":"object","properties":{"firstName":{"type":"string","description":"Imię nadawcy"},"lastName":{"type":"string","description":"Nazwisko nadawcy"},"email":{"type":"string","description":"Adres email nadawcy"},"phone":{"type":"string","description":"Numer telefonu nadawcy"},"street":{"type":"string","description":"Ulica"},"houseNumber":{"type":"string","description":"Numer domu"},"flatNumber":{"type":"string","description":"Numer mieszkania"},"city":{"type":"string","description":"Miasto"},"postCode":{"type":"string","description":"Kod pocztowy"},"country":{"type":"string","description":"Kraj","example":"PL"},"company":{"type":"string","description":"Nazwa firmy nadawcy"},"nip":{"type":"string","description":"Nip firmy nadawcy"},"point":{"description":"Punkt nadania","allOf":[{"$ref":"#/components/schemas/PointDataShort"}]}}},"OrderReceiverData":{"type":"object","properties":{"firstName":{"type":"string","description":"Imię odbiorcy"},"lastName":{"type":"string","description":"Nazwisko odbiorcy"},"email":{"type":"string","description":"Adres email odbiorcy"},"phone":{"type":"string","description":"Numer telefonu odbiorcy"},"street":{"type":"string","description":"Ulica"},"houseNumber":{"type":"string","description":"Numer domu"},"flatNumber":{"type":"string","description":"Numer mieszkania"},"city":{"type":"string","description":"Miasto"},"postCode":{"type":"string","description":"Kod pocztowy"},"country":{"type":"string","description":"Kraj","example":"PL"},"company":{"type":"string","description":"Nazwa firmy odbiorcy"},"point":{"description":"Punkt odbioru","allOf":[{"$ref":"#/components/schemas/PointDataShort"}]}}},"Content":{"type":"object","properties":{"content":{"type":"string","description":"Informacja o zawartości"},"value":{"type":"number","description":"Wartość zawartości","format":"decimal"},"quantity":{"type":"number","description":"Ilość sztuk","format":"decimal"},"weight":{"type":"number","description":"waga przedmiotu","format":"decimal"},"origin":{"type":"string","description":"Pochodzenie przedmiotu"},"code":{"type":"string","description":"Kod przedmiotu"},"codeName":{"type":"string","description":"Nazwa dla kodu przedmiotu"}}},"CodData":{"type":"object","properties":{"amount":{"type":"number","description":"Wartość pobrania","format":"decimal"},"bankAccount":{"type":"string","description":"Numer konta bankowego do zwrotu pobrania"},"codType":{"type":"string","description":"Rodzaj pobrania","enum":["cod.1dr","cod.3dr","cod.7dr","cod.10dr","cod.21dr","cod.saldo","cod.vip"]},"codTypeDescription":{"type":"string","description":"Opis do usługi pobrania"},"codReturnType":{"type":"string","description":"Typ zwrotu pobrania
account - Zwrot pobrania na konto bankowe lub saldo
cash - Zwrot pobrania w punkcie epaka.pl
","enum":["account","cashe"]},"codReturnPoint":{"description":"Punkt epaka.pl wybrany do zwrot pobrania.","allOf":[{"$ref":"#/components/schemas/PointDataShort"}]},"payOutDate":{"type":"string","description":"Planowana data zwrotu pobrania w standardzie ISO 8601"},"payOutRealDate":{"type":"string","description":"Data wykonania zwrotu pobrania w standardzie ISO 8601"}}},"Service":{"type":"object","properties":{"apiName":{"type":"string","description":"Identyfikator usługi w api"},"name":{"type":"string","description":"Nazwa usługi"}}},"OrderService":{"type":"object","properties":{"cod":{"type":"boolean","description":"Zamówienie z usługą pobrania"},"codData":{"description":"szczegóły usługi pobrania","nullable":true,"allOf":[{"$ref":"#/components/schemas/CodData"}]},"insurance":{"type":"boolean","description":"Informacja o wybraniu usługi ubezpieczenia"},"declaredValue":{"type":"number","description":"Wartość ubezpieczenia/przesyłk.","format":"decimal"},"servicesList":{"description":"Lista z wybranymi usługami dodatkowymi","type":"array","items":{"$ref":"#/components/schemas/Service"}}}},"PickupData":{"type":"object","properties":{"number":{"type":"string","nullable":true,"description":"Numer zamówienia kuriera"},"date":{"type":"string","description":"Dzień odbioru w standardzie ISO 8601"},"timeFrom":{"type":"string","description":"Godzina od"},"timeTo":{"type":"string","description":"Godzina do"}}},"Shape":{"type":"object","properties":{"id":{"type":"integer","description":"Identyfikator kształtu opakowania"},"name":{"type":"string","description":"Nazwa kształtu opakowania"}}},"PackageDetails":{"type":"object","properties":{"length":{"type":"number","description":"Długość paczki","format":"decimal"},"width":{"type":"number","description":"Szerokość paczki","format":"decimal"},"height":{"type":"number","description":"Wysokość paczki","format":"decimal"},"weight":{"type":"number","description":"Waga paczki","format":"decimal"},"dimensionalWeight":{"type":"number","description":"Waga gabarytowa opakowania","format":"decimal"},"unsortableShape":{"type":"boolean","description":"Kształt nie standardowy"},"shape":{"description":"Kształt opakowania","allOf":[{"$ref":"#/components/schemas/Shape"}]}}},"CustomsServiceDetails":{"type":"object","properties":{"purpose":{"type":"string","description":"Przeznaczenie przesyłki:","enum":["gift","not_sold","personal_effects","repair_and_return","sample","sold","documents","return"]},"eori":{"type":"string","description":"Eori"},"pesel":{"type":"string","description":"Pesel nadawcy"},"hmrc":{"type":"string","description":"Hmrc"}}},"OrderDetailsResponse":{"type":"object","properties":{"id":{"type":"integer","description":"Identyfikator zamówienia"},"sender":{"description":"Dane nadawcy","allOf":[{"$ref":"#/components/schemas/OrderSenderData"}]},"receiver":{"description":"Dane odbiorcy","allOf":[{"$ref":"#/components/schemas/OrderReceiverData"}]},"shippingType":{"type":"string","description":"Rodzaj wysyłki:
envelop - Koperta
package - Paczka
pallet - Paleta
","enum":["envelop","package","pallet"]},"content":{"type":"string","description":"Zawartość przesyłki podana podczas składania zamówienia"},"contents":{"description":"Szczegółowa zawartość podana podczas składania zamówienia","type":"array","items":{"$ref":"#/components/schemas/Content"}},"comments":{"type":"string","description":"Komentarz do zamówienia"},"labelNumber":{"type":"string","nullable":true,"description":"Numer listu przewozowego"},"additionalLabelNumber":{"type":"string","nullable":true,"description":"Dodatkowy numer listu przewozowego lub kod do nadania w paczkomacie (InPost Kurier - \"Nadanie bez etykiety w paczkomacie.\")"},"courier":{"description":"Kurier","allOf":[{"$ref":"#/components/schemas/ShortCourierData"}]},"services":{"description":"Usługi dodatkowe do zamówienia","allOf":[{"$ref":"#/components/schemas/OrderService"}]},"orderStatus":{"type":"string","enum":["waiting_for_payment","paid","ended","errors","canceled","in_progress"],"description":"Status zamówienia"},"packageStatus":{"type":"string","description":"Status przesyłki","enum":["package_no_send","package_received_from_sender","package_on_transit","package_in_delivery","package_delivered","package_delivery_problem","package_damaged","wrong_address","return_to_sender","package_sending_in_point","package_waiting_in_point","package_sending_in_paczkomat","package_waiting_in_paczkomat"]},"netPrice":{"type":"number","description":"Kwota netto zamówienia","format":"decimal"},"grossPrice":{"type":"number","description":"Kwota brutto zamówienia","format":"decimal"},"pickupData":{"description":"Informacja o podjeździe.","nullable":true,"allOf":[{"$ref":"#/components/schemas/PickupData"}]},"deliveryDate":{"type":"string","description":"Dzień doręczenia w standardzie ISO 8601","nullable":true},"plannedDeliveryDate":{"type":"string","description":"Planowany data doręczenia w standardzie ISO 8601","nullable":true},"orderDate":{"format":"date-time","type":"string","description":"Data złożenia zamówienia"},"packages":{"description":"Lista paczek w zamówieniu","type":"array","items":{"$ref":"#/components/schemas/PackageDetails"}},"customsService":{"description":"Informację związane z obsługą celną","allOf":[{"$ref":"#/components/schemas/CustomsServiceDetails"}]}}},"AvailabilityResponse":{"type":"object","properties":{"label":{"type":"boolean","description":"Dostępność etykiety przewozowej"},"zebraLabel":{"type":"boolean","description":"Dostępność etykiety przewozowej w formacie Zebra"},"protocol":{"type":"boolean","description":"Dostępność protokołu przewozowego"},"proforma":{"type":"boolean","description":"Dostępność faktury proforma"},"authorizationDocument":{"type":"boolean","description":"Dostępność upoważnienia do odprawy celnej"},"hvEcxDocument":{"type":"boolean"},"lvDocument":{"type":"boolean"},"statementDocument":{"type":"boolean"},"exporterStatement":{"type":"boolean"}}},"PaymentData":{"type":"object","properties":{"id":{"type":"integer","description":"Identyfikator płatności w systemie epaka.pl"},"amount":{"type":"number","description":"Kwota do zapłaty","format":"decimal"},"paypalCommission":{"type":"number","description":"Prowizja (Paypal)","format":"decimal"},"provider":{"type":"string","description":"Operatora płatności","enum":["p24","blik","paypal"]},"description":{"type":"string","description":"Opis do płatności"},"type":{"type":"string","description":"Rodzaj płatności","enum":["balance","payment_for_order","payment_for_orders","collective","payment_for_invoice"]},"status":{"type":"string","description":"Aktualny status płatności","enum":["waiting_for_payment","done","rejected","added_to_collective","done_collective","invalid"]},"additionalMessage":{"type":"string","description":"Dodatkowa informacja do wysietlenia użytkownikowi.","nullable":true}}},"BaseApiResponse":{"type":"object","properties":{"message":{"type":"string","nullable":true,"description":"Komunikat do wyświetlenia użytkownikowi."}}},"OrderPaymentStatusResponse":{"type":"object","properties":{"status":{"type":"string","description":"Status płatności:
waiting_for_payment - Oczekuje na płatność
done - Płatność wykonana
rejected - Płatność odrzucona
invalid - Płatność nieaktualna
","enum":["waiting_for_payment","done","rejected","invalid"]}}},"Document":{"type":"object","properties":{"document":{"type":"string","description":"Dokument w formacie PDF zakodowana w postaci base64"}}},"OrdersResponse":{"type":"object","properties":{"orders":{"description":"Lista zamówień","type":"array","items":{"$ref":"#/components/schemas/Order"}}}},"AddressBookData":{"type":"object","properties":{"id":{"type":"integer","description":"Identyfikator adresu"},"name":{"type":"string","description":"Nazwa"},"firstName":{"type":"string","description":"Imię"},"lastName":{"type":"string","description":"Nazwisko"},"company":{"type":"string","description":"Nazwa firmy"},"street":{"type":"string","description":"Ulica"},"houseNumber":{"type":"string","description":"Numer domu"},"flatNumber":{"type":"string","description":"Numer mieszkania"},"city":{"type":"string","description":"Miasto"},"postCode":{"type":"string","description":"Kod pocztowy"},"phone":{"type":"string","description":"Numer telefonu"},"email":{"type":"string","description":"Adres email"}}},"AddressBookResponse":{"type":"object","properties":{"addresses":{"description":"Lista adresów","type":"array","items":{"$ref":"#/components/schemas/AddressBookData"}},"count":{"type":"integer","description":"Liczba wszystkich dostępnych adresów."}}},"AddressBookDetailsResponse":{"type":"object","properties":{"id":{"type":"integer","description":"Identyfikator adresu"},"name":{"type":"string","description":"Nazwa"},"firstName":{"type":"string","description":"Imię"},"lastName":{"type":"string","description":"Nazwisko"},"company":{"type":"string","description":"Nazwa firmy"},"street":{"type":"string","description":"Ulica"},"houseNumber":{"type":"string","description":"Numer domu"},"flatNumber":{"type":"string","description":"Numer mieszkania"},"city":{"type":"string","description":"Miasto"},"postCode":{"type":"string","description":"Kod pocztowy"},"country":{"type":"string","description":"Kraj"},"phone":{"type":"string","description":"Numer telefonu"},"email":{"type":"string","description":"Adres email"},"points":{"description":"Domyślne punkty nadania, dla wybranych kurierów","type":"array","items":{"$ref":"#/components/schemas/PointDataShort"}}}},"AddressBookDataPayload":{"type":"object","properties":{"name":{"type":"string","description":"Nazwa","maxLength":50},"firstName":{"type":"string","description":"Imię","maxLength":19},"lastName":{"type":"string","description":"Nazwisko","maxLength":29},"company":{"type":"string","description":"Nazwa firmy","maxLength":100},"street":{"type":"string","description":"Ulica","maxLength":60},"houseNumber":{"type":"string","description":"Numer domu","maxLength":7},"flatNumber":{"type":"string","description":"Numer mieszkania","maxLength":6},"city":{"type":"string","description":"Miasto","maxLength":50},"postCode":{"type":"string","description":"Kod pocztowy","maxLength":10},"country":{"type":"string","description":"Kraj","maxLength":2,"minLength":2,"example":"PL"},"phone":{"type":"string","description":"Numer telefonu","example":"+48 123 123 123"},"email":{"type":"string","description":"Adres email","example":"bok@epaka.pl"},"points":{"description":"Domyślne punkty nadania, dla wybranych kurierów","type":"array","items":{"$ref":"#/components/schemas/PointDataShort"}}},"required":["name","firstName","lastName","street","houseNumber","city","postCode","country","phone"]},"PaymentsResponse":{"type":"object","properties":{"payments":{"description":"Lista płatności","type":"array","items":{"$ref":"#/components/schemas/PaymentData"}},"count":{"type":"integer","description":"Liczba wszystkich dostępnych płatności."}}},"PaymentQuery":{"type":"object","properties":{"provider":{"type":"string","description":"Operator płatności","enum":["p24","blik","paypal"]}}},"PayRequest":{"type":"object","properties":{"blikCode":{"type":"string","description":"Kod blik. Wymagany gdy operator płatności `blik`"},"regulationAccept":{"type":"boolean","description":"Akceptacja regulaminu operatora płatności","default":false}}},"PaymentStatusResponse":{"type":"object","properties":{"id":{"type":"integer","description":"Identyfikator płatność"},"status":{"type":"string","description":"Status płatności","enum":["waiting_for_payment","done","rejected","added_to_collective","done_collective","invalid"]}}},"CreateCollectivePaymentBody":{"type":"object","properties":{"payments":{"description":"Identyfikatory płatności, które mają zostać dodane do płatności zbiorczej.","type":"array","items":{"type":"integer"}}},"required":["payments"]},"InvoiceData":{"type":"object","properties":{"id":{"type":"integer","description":"Identyfikator faktury"},"number":{"type":"string","description":"Numer faktury"},"grossPrice":{"type":"number","description":"Kwota brutto na fakturze","format":"decimal"},"netPrice":{"type":"number","description":"Kwota netto na fakturze","format":"decimal"},"paid":{"type":"boolean","description":"Faktura opłacona"},"paidAmount":{"type":"number","description":"Kwota która została juz zapłacona","format":"decimal"},"remainingAmount":{"type":"number","description":"Kwota pozostała do zapłacenia","format":"decimal"},"dateOfIssue":{"type":"string","description":"Data wystawienia faktury"},"paymentDeadline":{"type":"string","description":"Termin płatności za fakture"},"paymentStatus":{"type":"string","description":"Status płatności przypisanej do faktury"}}},"InvoicesResponse":{"type":"object","properties":{"invoices":{"description":"Lista faktur użytkownika","type":"array","items":{"$ref":"#/components/schemas/InvoiceData"}},"count":{"type":"integer","description":"Liczba wszystkich dostępnych faktur."}}},"InvoiceBuyerData":{"type":"object","properties":{"name":{"type":"string","description":"Nazwa"},"address":{"type":"string","description":"Adres (Ulica, Numer budynku/lokalu)"},"city":{"type":"string","description":"Miasto"},"country":{"type":"string","description":"Kraj"},"nip":{"type":"string","description":"Numer Nip"}}},"InvoiceDetailsResponse":{"type":"object","properties":{"id":{"type":"integer","description":"Identyfikator faktury"},"number":{"type":"string","description":"Numer faktury"},"grossPrice":{"type":"number","description":"Kwota brutto na fakturze","format":"decimal"},"netPrice":{"type":"number","description":"Kwota netto na fakturze","format":"decimal"},"paid":{"type":"boolean","description":"Faktura opłacona"},"paidAmount":{"type":"number","description":"Kwota która została juz zapłacona","format":"decimal"},"remainingAmount":{"type":"number","description":"Kwota pozostała do zapłacenia","format":"decimal"},"dateOfIssue":{"type":"string","description":"Data wystawienia faktury"},"paymentDeadline":{"type":"string","description":"Termin płatności za fakture"},"paymentStatus":{"type":"string","description":"Status płatności przypisanej do faktury"},"createType":{"type":"string","description":"Sposób wystawienia"},"seller":{"type":"string","description":"Dane sprzedającego"},"buyer":{"description":"Dane sprzedającego","allOf":[{"$ref":"#/components/schemas/InvoiceBuyerData"}]},"date":{"format":"date-time","type":"string","description":"Data utworzenia"}}},"InvoiceUrl":{"type":"object","properties":{"url":{"type":"string","description":"Link do pobrania faktury"}}},"InvoiceCreateCollectivePaymentBody":{"type":"object","properties":{"invoices":{"description":"Identyfikatory faktur, które mają zostać dodane do płatności zbiorczej.","type":"array","items":{"type":"integer"}}},"required":["invoices"]},"Invoice":{"type":"object","properties":{}},"InvoicesFullResponse":{"type":"object","properties":{"invoices":{"description":"Lista faktur","type":"array","items":{"$ref":"#/components/schemas/Invoice"}}}},"CartItemData":{"type":"object","properties":{"paymentId":{"type":"integer","description":"Id płatności"},"description":{"type":"string","description":"Opis płatności"},"grossPrice":{"type":"number","description":"Kwota brutto płatności","format":"decimal"},"netPrice":{"type":"number","description":"Kwota netto płatności","format":"decimal"},"type":{"type":"string","description":"Typ płatności","enum":["online_payment","balance"]}}},"CartResponse":{"type":"object","properties":{"grossPrice":{"type":"number","description":"Kwota brutto z płatności dodanych do koszyka","format":"decimal"},"netPrice":{"type":"number","description":"Kwota netto z płatności dodanych do koszyka","format":"decimal"},"items":{"description":"Lista płatności dodanych do koszyka","type":"array","items":{"$ref":"#/components/schemas/CartItemData"}}}},"AddToCartPayload":{"type":"object","properties":{"payments":{"description":"Lista identyfikatorów płatności do dodania, do koszyka","type":"array","items":{"type":"integer"}},"orders":{"description":"Lista identyfikatorów zamówienia do dodania, do koszyka","type":"array","items":{"type":"integer"}}}},"TemplateModel":{"type":"object","properties":{"id":{"type":"integer","description":"Identyfikator szablonu"},"date":{"format":"date-time","type":"string","description":"Data utworzenia szablonu."},"name":{"type":"string","description":"Nazwa szablonu"},"shippingType":{"type":"string","description":"Rodzaj wysyłki"},"default":{"type":"boolean","description":"Szablon domyślny."},"courier":{"description":"Dane kuriera","allOf":[{"$ref":"#/components/schemas/ShortCourierData"}]}}},"TemplatesResponse":{"type":"object","properties":{"templates":{"description":"Lista szablonów","type":"array","items":{"$ref":"#/components/schemas/TemplateModel"}},"count":{"type":"integer","description":"Liczba wszystkich dostępnych zamówień."}}},"TemplateSenderData":{"type":"object","properties":{"firstName":{"type":"string","description":"Imię nadawcy"},"lastName":{"type":"string","description":"Nazwisko nadawcy"},"email":{"type":"string","description":"Adres email nadawcy"},"phone":{"type":"string","description":"Numer telefonu nadawcy"},"street":{"type":"string","description":"Ulica"},"houseNumber":{"type":"string","description":"Numer domu"},"flatNumber":{"type":"string","description":"Numer mieszkania"},"city":{"type":"string","description":"Miasto"},"postCode":{"type":"string","description":"Kod pocztowy"},"country":{"type":"string","description":"Kraj","example":"PL"},"company":{"type":"string","description":"Nazwa firmy nadawcy"},"nip":{"type":"string","description":"Nip firmy nadawcy"},"point":{"description":"Punkt nadania","allOf":[{"$ref":"#/components/schemas/PointDataShort"}]}}},"TemplateReceiverData":{"type":"object","properties":{"firstName":{"type":"string","description":"Imię odbiorcy"},"lastName":{"type":"string","description":"Nazwisko odbiorcy"},"email":{"type":"string","description":"Adres email odbiorcy"},"phone":{"type":"string","description":"Numer telefonu odbiorcy"},"street":{"type":"string","description":"Ulica"},"houseNumber":{"type":"string","description":"Numer domu"},"flatNumber":{"type":"string","description":"Numer mieszkania"},"city":{"type":"string","description":"Miasto"},"postCode":{"type":"string","description":"Kod pocztowy"},"country":{"type":"string","description":"Kraj","example":"PL"},"company":{"type":"string","description":"Nazwa firmy odbiorcy"},"nip":{"type":"string","description":"Nip firmy odbiorcy"},"point":{"description":"Punkt odbioru","allOf":[{"$ref":"#/components/schemas/PointDataShort"}]}}},"TemplateCodData":{"type":"object","properties":{"amount":{"type":"number","description":"Wartość pobrania","format":"decimal"},"bankAccount":{"type":"string","description":"Numer konta bankowego do zwrotu pobrania"},"codType":{"type":"string","description":"Rodzaj pobrania","enum":["cod.1dr","cod.3dr","cod.7dr","cod.10dr","cod.21dr","cod.saldo","cod.vip"]},"codTypeDescription":{"type":"string","description":"Opis do usługi pobrania"},"codReturnType":{"type":"string","description":"Typ zwrotu pobrania
account - Zwrot pobrania na konto bankowe lub saldo
cash - Zwrot pobrania w punkcie epaka.pl
","enum":["account","cashe"]},"codReturnPoint":{"description":"Punkt epaka.pl wybrany do zwrot pobrania.","allOf":[{"$ref":"#/components/schemas/PointDataShort"}]}}},"TemplateServices":{"type":"object","properties":{"cod":{"type":"boolean","description":"Zamówienie z usługą pobrania"},"codData":{"description":"szczegóły usługi pobrania","nullable":true,"allOf":[{"$ref":"#/components/schemas/TemplateCodData"}]},"insurance":{"type":"boolean","description":"Informacja o wybraniu usługi ubezpieczenia"},"declaredValue":{"type":"number","description":"Wartość ubezpieczenia/przesyłk.","format":"decimal"},"servicesList":{"description":"Lista z wybranymi usługami dodatkowymi","type":"array","items":{"$ref":"#/components/schemas/Service"}}}},"TemplatePackageDetails":{"type":"object","properties":{"length":{"type":"number","description":"Długość paczki","format":"decimal"},"width":{"type":"number","description":"Szerokość paczki","format":"decimal"},"height":{"type":"number","description":"Wysokość paczki","format":"decimal"},"weight":{"type":"number","description":"Waga paczki","format":"decimal"},"unsortableShape":{"type":"boolean","description":"Kształt nie standardowy"},"shape":{"description":"Kształt opakowania","allOf":[{"$ref":"#/components/schemas/Shape"}]}}},"TiresData":{"type":"object","properties":{"quantity":{"type":"number","description":"Liczba sztuk.","format":"int"},"width":{"type":"number","description":"Szerokość","format":"int"},"profile":{"type":"number","description":"Profil","format":"int"},"diameter":{"type":"number","description":"Średnica","format":"decimal"}},"required":["quantity","width","profile","diameter"]},"TemplateResponse":{"type":"object","properties":{"id":{"type":"int","description":"Id szablonu"},"shippingType":{"type":"string","description":"Rodzaj wysyłki:
envelope - Koperta
package - Paczka
pallet - Paleta
tires - Opony
","enum":["envelope","package","pallet","tires"]},"courier":{"description":"Kurier","allOf":[{"$ref":"#/components/schemas/ShortCourierData"}]},"sender":{"description":"Dane nadawcy","allOf":[{"$ref":"#/components/schemas/TemplateSenderData"}]},"receiver":{"description":"Dane odbiorcy","allOf":[{"$ref":"#/components/schemas/TemplateReceiverData"}]},"services":{"description":"Usługi dodatkowe","allOf":[{"$ref":"#/components/schemas/TemplateServices"}]},"packages":{"description":"Lista paczek","type":"array","items":{"$ref":"#/components/schemas/TemplatePackageDetails"}},"tires":{"description":"Parametry opon.","allOf":[{"$ref":"#/components/schemas/TiresData"}]}}},"TemplateSenderAddressData":{"type":"object","properties":{"name":{"type":"string","description":"Imię","minLength":2,"maxLength":50,"example":"Jan"},"lastName":{"type":"string","description":"Nazwisko","minLength":2,"maxLength":100,"example":"Nowak"},"company":{"type":"string","description":"Firma","minLength":4,"maxLength":200,"nullable":true},"nip":{"type":"string","description":"Nip firmy","nullable":true},"country":{"type":"string","description":"Kraj","minLength":2,"maxLength":2,"nullable":true,"example":"PL"},"city":{"type":"string","description":"Miasto","maxLength":50,"example":"Łuków"},"street":{"type":"string","description":"Ulica","maxLength":60,"example":"Sochacz"},"houseNumber":{"type":"string","description":"Numer domu","maxLength":7,"example":"15"},"flatNumber":{"type":"string","description":"Numer lokalu","maxLength":6},"postCode":{"type":"string","description":"Kod pocztowy","maxLength":10,"example":"21-400"},"phone":{"type":"string","description":"Numer telefonu","minLength":9,"maxLength":15,"example":"123456789"},"email":{"type":"string","description":"Adres email","maxLength":100,"example":"bok@epaka.pl"},"pointId":{"type":"string","description":"Id punkt nadania"},"pointDescription":{"type":"string","description":"Nazwa punkt nadania","maxLength":100}}},"TemplateReceiverAddressData":{"type":"object","properties":{"name":{"type":"string","description":"Imię (Dla kuriera InPost Paczkomaty pole opcjonalne)","minLength":2,"maxLength":50,"example":"Jan"},"lastName":{"type":"string","description":"Nazwisko (Dla kuriera InPost Paczkomaty pole opcjonalne)","minLength":2,"maxLength":100,"example":"Nowak"},"company":{"type":"string","description":"Firma","minLength":4,"maxLength":200,"nullable":true},"nip":{"type":"string","description":"Nip firmy","nullable":true},"country":{"type":"string","description":"Kraj (Dla kuriera InPost Paczkomaty pole opcjonalne)","minLength":2,"maxLength":2,"nullable":true,"example":"PL"},"city":{"type":"string","description":"Miasto (Dla kuriera InPost Paczkomaty pole opcjonalne)","maxLength":50,"example":"Łuków"},"street":{"type":"string","description":"Ulica (Dla kuriera InPost Paczkomaty pole opcjonalne)","maxLength":60,"example":"Sochacz"},"houseNumber":{"type":"string","description":"Numer domu (Dla kuriera InPost Paczkomaty pole opcjonalne)","maxLength":7,"example":"15"},"flatNumber":{"type":"string","description":"Numer lokalu (Dla kuriera InPost Paczkomaty pole opcjonalne)","maxLength":6},"postCode":{"type":"string","description":"Kod pocztowy (Dla kuriera InPost Paczkomaty pole opcjonalne)","maxLength":10,"example":"21-400"},"phone":{"type":"string","description":"Numer telefonu","minLength":9,"maxLength":15,"example":"123456789"},"email":{"type":"string","description":"Adres email
Pole wymagane dla:
InPost Kurier (id: 12) - z wybranymi usługami \"infoServiceEmail\" - Serwis e-mail lub labelSendInLocker - Nadanie w paczkomacie z etykietą
InPost Paczkomaty (id: 6)
InPost International (id: 57)
FedEx Punkt (id: 45)
DHL (id: 8) - jeżeli kraj odbioru jest inny niż PL
DHL Servicepoint (id: 22)
DHL Express (id: 23)
Meest (id: 14)
Nova Poshta (id: 53)
","maxLength":100,"example":"bok@epaka.pl"},"pointId":{"type":"string","description":"Id punkt obioru"},"pointDescription":{"type":"string","description":"Nazwa punkt odbioru","maxLength":100}}},"TemplateServicesData":{"type":"object","properties":{"cod":{"type":"boolean","description":"Usługa pobrania","default":false},"codReturnType":{"type":"string","default":"account","description":"Rodzaj pobrania:
account - Zwrot pobrania na konto bankowe lub saldo
cash - Zwrot pobrania w punkcie epaka.pl
","enum":["account","cash"]},"codReturnPointId":{"type":"string","description":"Id punkt odbioru pobrania (punkt epaka.pl)"},"codType":{"type":"string","description":"Rodzaj pobrania (apiName)","example":"cod.10dr"},"codAmount":{"type":"number","description":"Wartość kwoty pobrania","format":"decimal"},"bankAccount":{"type":"string","description":"Numer konta bankowego do zwrotu pobrania","example":"12345678901234567890123456"},"insurance":{"type":"boolean","description":"Usługa ubezpieczenia","default":false},"declaredValue":{"type":"number","description":"Wartość przesyłki(ubezpieczenia)","format":"decimal"},"additionalServices":{"description":"Lista z identyfikatorami(apiName) wybranych usług dodatkowych","type":"array","items":{"type":"string"}}}},"TemplatePackageData":{"type":"object","properties":{"weight":{"type":"number","description":"Waga","format":"decimal"},"height":{"type":"number","description":"Wysokość","format":"decimal"},"width":{"type":"number","description":"Szerokość","format":"decimal"},"length":{"type":"number","description":"Długość","format":"decimal"},"type":{"type":"integer","description":"Id rodzaju opakowania
0 – Opakowanie standardowe
1 – Opakowanie niestandardowe
lub inny rodzaj opakowania."}}},"TemplateTiresData":{"type":"object","properties":{"quantity":{"type":"number","description":"Liczba sztuk.","format":"int"},"width":{"type":"number","description":"Szerokość","format":"int"},"profile":{"type":"number","description":"Profil","format":"int"},"diameter":{"type":"number","description":"Średnica","format":"decimal"}}},"TemplatePayload":{"type":"object","properties":{"name":{"type":"string","description":"Nazwa szablonu"},"sender":{"description":"Dane adresowe nadawcy","allOf":[{"$ref":"#/components/schemas/TemplateSenderAddressData"}]},"receiver":{"description":"Dane adresowe odbiorcy","allOf":[{"$ref":"#/components/schemas/TemplateReceiverAddressData"}]},"courierId":{"type":"integer","description":"Id kuriera"},"shippingType":{"type":"string","description":"Rodzaj wysyłki:
envelope - Koperta
package - Paczka
pallet - Paleta
tires - Opony
","enum":["envelope","package","pallet","tires"]},"services":{"description":"Usługi dodatkowe do zamówienia","allOf":[{"$ref":"#/components/schemas/TemplateServicesData"}]},"packages":{"description":"Lista z wymiarami przesyłek","type":"array","items":{"$ref":"#/components/schemas/TemplatePackageData"}},"tires":{"description":"Parametry opon.
Wymagane dla shippingType: tires","allOf":[{"$ref":"#/components/schemas/TemplateTiresData"}]},"default":{"type":"boolean","description":"Szablon ma być domyślny, dla wybranego typu wysyłki"}},"required":["name"]},"CourierData":{"type":"object","properties":{"id":{"type":"integer","description":"Identyfikator kuriera w systemie epaka.pl"},"name":{"type":"string","description":"Nazwa kuriera"},"logo":{"type":"string","description":"Logo kuriera"},"courierDeliveryType":{"type":"string","description":"Sposób odbioru przesyłki","enum":["door","point"]},"shipmentFromPoint":{"type":"boolean","description":"Możliwość nadania w punkcie"},"shipmentFromDoor":{"type":"boolean","description":"Kurier przyjeżdża po paczkę"},"international":{"type":"boolean","description":"Kurier międzynarodowy"},"courierWithPoint":{"type":"boolean","description":"Kurier posiada punkty nadania"}}},"CouriersResponse":{"type":"object","properties":{"couriers":{"description":"Lista dostępnych kurierów","type":"array","items":{"$ref":"#/components/schemas/CourierData"}}}},"CountryData":{"type":"object","properties":{"name":{"type":"string","description":"Nazwa kraju"},"code":{"type":"string","description":"Kod kraju"},"ue":{"type":"boolean","description":"Kraj należy do UE"},"examplePostCode":{"type":"string","description":"Przykładowy kod pocztowy"},"postCodeMinLength":{"type":"number","description":"Minimalna długość kodu pocztowego"},"postCodeMaxLength":{"type":"number","description":"Maksymalna długość kodu pocztowego"},"postCodeLetters":{"type":"boolean","description":"Kod pocztowego zawiera litery"},"postCodeRegex":{"type":"string","description":"Regex kodu pocztowego"},"image":{"type":"string","description":"Link do flagi kraju"},"callingCode":{"type":"string","description":"Prefix numeru telefonu","example":"+48"}}},"CountriesResponse":{"type":"object","properties":{"countries":{"description":"Lista krajów","type":"array","items":{"$ref":"#/components/schemas/CountryData"}}}},"Step":{"type":"object","properties":{"date":{"format":"date-time","type":"string","description":"Data dodania statusu do systemu"},"code":{"type":"string","description":"Kod statusu"},"status":{"type":"string","description":"Opis statusu"}}},"TrackingDetailsResponse":{"type":"object","properties":{"traces":{"description":"Lista statusów kurierskich","type":"array","items":{"$ref":"#/components/schemas/Step"}},"courier":{"description":"Dane kuriera obsługującego przesyłkę","allOf":[{"$ref":"#/components/schemas/ShortCourierData"}]}}},"PointData":{"type":"object","properties":{"id":{"type":"string","description":"Identyfikator punktu"},"name":{"type":"string","description":"Nazwa punktu"},"latitude":{"type":"number","description":"Latitude"},"longitude":{"type":"number","description":"Longitude"},"city":{"type":"string","description":"Miasto"},"street":{"type":"string","description":"Ulica"},"number":{"type":"string","description":"Numer budynku"},"localNumber":{"type":"string","description":"Numer lokalu"},"postCode":{"type":"string","description":"Kod pocztowy"},"email":{"type":"string","description":"Email"},"phone":{"type":"string","description":"Numer telefonu"},"www":{"type":"string","description":"Address www"},"other":{"type":"string","description":"Inne dane dotyczące punktu."},"courier":{"description":"Kuriera","allOf":[{"$ref":"#/components/schemas/ShortCourierData"}]},"openingHours":{"description":"Godziny otwarcia","type":"array","items":{"type":"string"}}}},"PointsResponse":{"type":"object","properties":{"points":{"description":"Lista znalezionych punktów","type":"array","items":{"$ref":"#/components/schemas/PointData"}}}},"Point":{"type":"object","properties":{}},"PointsFullResponse":{"type":"object","properties":{"points":{"description":"Lista znalezionych punktów","type":"array","items":{"$ref":"#/components/schemas/Point"}}}},"CheckContentPayload":{"type":"object","properties":{"content":{"type":"string","description":"Zawartość"},"courierId":{"type":"number","description":"Identyfikator kuriera w systemie epaka.pl"}},"required":["content","courierId"]},"CheckContentResponse":{"type":"object","properties":{"description":{"type":"string","description":"Opis do wyswietlenia użytkownikowi."},"hiperlink":{"type":"string","description":"Link do szczegółów lub do poradnika."},"validation":{"type":"string","description":""},"infotipAlias":{"type":"string","description":""}}},"ShippingTypeData":{"type":"object","properties":{"value":{"type":"string","description":"Wartość enum rodzaju wysyłki, potrzebna do utworzenia zamówienia"},"name":{"type":"string","description":"Nazwa typu"}}},"ShippingTypesResponse":{"type":"object","properties":{"shippingTypes":{"description":"Lista dostępnych rodzajów wysyłki","type":"array","items":{"$ref":"#/components/schemas/ShippingTypeData"}}}},"PackageSizeData":{"type":"object","properties":{"weight":{"type":"number","nullable":true,"description":"Waga","format":"decimal"},"height":{"type":"number","nullable":true,"description":"Wysokość","format":"decimal"},"width":{"type":"number","nullable":true,"description":"Szerokość","format":"decimal"},"length":{"type":"number","nullable":true,"description":"Długość","format":"decimal"}}},"PackageType":{"type":"object","properties":{"id":{"type":"integer","description":"Identyfikator opakowania"},"name":{"type":"string","description":"Nazwa opakowania"},"description":{"type":"string","description":"Opis do opakowania"},"image":{"type":"string","description":"Link do ikony"},"size":{"description":"Domyślne wymiary","allOf":[{"$ref":"#/components/schemas/PackageSizeData"}]}}},"PackageTypesResponse":{"type":"object","properties":{"types":{"description":"Lista dostępnych opakowań dla typu paczki","type":"array","items":{"$ref":"#/components/schemas/PackageType"}}}},"PackageData":{"type":"object","properties":{"weight":{"type":"number","description":"Waga","format":"decimal"},"height":{"type":"number","description":"Wysokość","format":"decimal"},"width":{"type":"number","description":"Szerokość","format":"decimal"},"length":{"type":"number","description":"Długość","format":"decimal"},"type":{"type":"integer","description":"Id rodzaju opakowania
0 – Opakowanie standardowe
1 – Opakowanie niestandardowe
lub inny rodzaj opakowania."}},"required":["weight","height","width","length","type"]},"PricesPayload":{"type":"object","properties":{"courierId":{"type":"integer","nullable":true,"description":"Id kuriera potrzebne do pojedynczej wyceny"},"onlyAvailable":{"type":"boolean","description":"Zwrócić ofertę tylko dostępną dla podanych parametrów","default":true},"shippingType":{"type":"string","description":"Rodzaj wysyłki:
envelope - Koperta
package - Paczka
pallet - Paleta
tires - Opony
","enum":["envelope","package","pallet","tires"]},"senderCountry":{"type":"string","description":"Kraj nadania","default":"PL","example":"PL"},"receiverCountry":{"type":"string","description":"Kraj odbioru","default":"PL","example":"PL"},"senderPostCode":{"type":"string","description":"Kod pocztowy nadawcy","example":"21-400"},"receiverPostCode":{"type":"string","description":"Kod pocztowy odbiorcy","example":"21-400"},"packages":{"description":"Wymiary przesyłek.
Wymagane dla shippingType: envelope, package, pallet","type":"array","items":{"$ref":"#/components/schemas/PackageData"}},"tires":{"description":"Parametry opon.
Wymagane dla shippingType: tires","allOf":[{"$ref":"#/components/schemas/TiresData"}]}},"required":["shippingType"]},"CourierPrice":{"type":"object","properties":{"courier":{"description":"Dane kuriera","allOf":[{"$ref":"#/components/schemas/ShortCourierData"}]},"courierDeliveryType":{"type":"string","description":"Sposób odbioru przesyłki","enum":["door","point"]},"shipmentFromPoint":{"type":"boolean","description":"Możliwość nadania w punkcie"},"shipmentFromDoor":{"type":"boolean","description":"Kurier przyjeżdża po paczkę"},"available":{"type":"boolean","description":"Czy kurier dostępny"},"errorMessage":{"type":"string","description":"Informacja o braku dostępności kuriera"},"netPriceTotal":{"type":"number","description":"Cena netto wysyłki","format":"decimal"},"grossPriceTotal":{"type":"number","description":"Cena brutto wysyłki","format":"decimal"}}},"PricesResponse":{"type":"object","properties":{"couriers":{"description":"Lista kurierów z wyceną","type":"array","items":{"$ref":"#/components/schemas/CourierPrice"}}}},"PickupDate":{"type":"object","properties":{"courierId":{"type":"integer","description":"Id kuriera"},"name":{"type":"string","description":"Nazwa kuriera"},"startDate":{"type":"string","description":"Pierwsza możliwa data podjazdu w standardzie ISO 8601"},"endDate":{"type":"string","description":"Ostatnia możliwa data podjazdu w standardzie ISO 8601"},"availableDates":{"description":"Tablica zawierająca zakres dostępnych dni podjazdu.","type":"array","items":{"type":"string"}}}},"PickupDateResponse":{"type":"object","properties":{"couriers":{"description":"Lista z datami nadania dla kurierów","type":"array","items":{"$ref":"#/components/schemas/PickupDate"}}}},"TimeSlot":{"type":"object","properties":{"timeFrom":{"type":"string","description":"Godzina od"},"timeTo":{"type":"string","description":"Godzina do"}}},"PickupHoursResponse":{"type":"object","properties":{"timeSlots":{"description":"Lista z dostępnymi godzinami podjazdu kuriera","type":"array","items":{"$ref":"#/components/schemas/TimeSlot"}}}},"CustomsServiceDescriptions":{"type":"object","properties":{"checkboxDescription":{"type":"string","description":"Opis do checkbox-a"},"hmrc":{"type":"string","description":"Opisy do hmrc"},"eori":{"type":"string","description":"Opisy do eori"},"nip":{"type":"string","description":"Opisy do nip-u"}}},"CustomsService":{"type":"object","properties":{"title":{"type":"string","description":"Nazwa do wyświetlenia"},"description":{"type":"string","description":"Opis do wyświetlenia"},"dutiesValue":{"type":"number","description":"Wartość przesyłki euro, od której wymagane jest podanie danych dla pól.","format":"decimal"},"descriptions":{"description":"Opisy do wybranych pól, przycisków, itp.","allOf":[{"$ref":"#/components/schemas/CustomsServiceDescriptions"}]}}},"PayOnDeliveryData":{"type":"object","properties":{"available":{"type":"boolean","description":"Dostępność usługi płatności przy doręczeniu"},"name":{"type":"string","description":"Nazwa do wyświetlenia"},"description":{"type":"string","description":"Opis do usługi."},"price":{"type":"number","description":"Cena usługi","format":"decimal"}}},"ServiceData":{"type":"object","properties":{"apiName":{"type":"string","description":"Nazwa api potrzebna do złożenia zamówienia"},"name":{"type":"string","description":"Nazwa usługi"},"price":{"type":"number","description":"Cena usługi","format":"decimal"},"priceType":{"type":"string","description":"Typ jaki przyjmuje wartość w polu \"price\":","enum":["percent","currency"]},"description":{"type":"string","description":"Opis do usługi"},"fieldType":{"type":"string","description":"Rodzaj pola","enum":["pickupRadio","sendRadio","insurance","regular","cod"],"nullable":true},"nonConnectingServices":{"description":"Usługi z którymi dana usługa nie może być połączona","type":"array","items":{"type":"string"}},"position":{"type":"integer","description":"Pozycja na liście","nullable":true},"selected":{"type":"boolean","description":"Usługa zaznaczona na start"},"requiredFields":{"description":"Wymagane pola, po zaznaczeniu usługi","type":"array","items":{"type":"string"}},"available":{"type":"boolean","description":"Czy usługa jest aktualnie dostępna"},"insuranceMaxValue":{"type":"number","description":"Maksymalna wartość jaką może przyjąć ubezpieczenie (tylko jeżeli usługa to ubezpieczenie)","format":"decimal"}}},"ServicesResponse":{"type":"object","properties":{"requiredFields":{"description":"Lista dodatkowych pól dla kuriera, które są wymagane przy składaniu zamówienia ","type":"array","items":{"type":"string"}},"optionalFields":{"description":"Lista dodatkowych pól dla kuriera, które są opcjonalne przy składaniu zamówienia","type":"array","items":{"type":"string"}},"customsService":{"nullable":true,"description":"Informację do obsługi celnej","allOf":[{"$ref":"#/components/schemas/CustomsService"}]},"payOnDelivery":{"description":"Informację o usłudze płatność przy doręczeniu","allOf":[{"$ref":"#/components/schemas/PayOnDeliveryData"}]},"services":{"description":"Lista usług dodatkowych","type":"array","items":{"$ref":"#/components/schemas/ServiceData"}}}},"CodPricesResponse":{"type":"object","properties":{"cod1dr":{"type":"number","description":"Cena dla usługi zwrotu pobrania 1DR","nullable":true,"format":"decimal"},"cod3dr":{"type":"number","description":"Cena dla usługi zwrotu pobrania 3DR","nullable":true,"format":"decimal"},"cod7dr":{"type":"number","description":"Cena dla usługi zwrotu pobrania 7DR","nullable":true,"format":"decimal"},"cod10dr":{"type":"number","description":"Cena dla usługi zwrotu pobrania 10DR","nullable":true,"format":"decimal"},"cod21dr":{"type":"number","description":"Cena dla usługi zwrotu pobrania 21DR","nullable":true,"format":"decimal"},"codSaldo":{"type":"number","description":"Cena dla usługi zwrotu pobrania na saldo","nullable":true,"format":"decimal"},"cod1drVip":{"type":"number","description":"Cena dla usługi zwrotu pobrania 1DR VIP","nullable":true,"format":"decimal"}}},"CodTypeData":{"type":"object","properties":{"apiName":{"type":"string","description":"apiName potrzebny do złożenia zamówienia"},"name":{"type":"string","description":"Nazwa usługi"},"description":{"type":"string","description":"Opis do usługi"},"selected":{"type":"boolean","description":"Informacja czy usługa domyślnie zaznaczona"},"maxValue":{"type":"number","description":"Maksymalna kwota pobrania","format":"decimal"}}},"CodTypesResponse":{"type":"object","properties":{"codTypes":{"description":"Lista z dostępnymi rodzajami pobrania","type":"array","items":{"$ref":"#/components/schemas/CodTypeData"}}}},"InsurancePriceResponse":{"type":"object","properties":{"price":{"type":"number","description":"Cena ubezpieczenia","format":"decimal"}}},"ItemCode":{"type":"object","properties":{"code":{"type":"string","description":"Kod produktu"},"name":{"type":"string","description":"Nazwa produktu"}}},"SearchItemCodeResponse":{"type":"object","properties":{"codes":{"description":"Lista kodów produktów","type":"array","items":{"$ref":"#/components/schemas/ItemCode"}}}},"CitiesResponse":{"type":"object","properties":{"cities":{"description":"Lista z miastami dla wybranego kodu pocztowego","type":"array","items":{"type":"string"}}}},"StreetsResponse":{"type":"object","properties":{"streets":{"description":"Lista z ulicami dla wybranego miasta","type":"array","items":{"type":"string"}}}},"PostCodeResponse":{"type":"object","properties":{"exists":{"type":"boolean","description":"Zwraca informację czy podany kod pocztowy istnieje"}}},"SenderAddressData":{"type":"object","properties":{"name":{"type":"string","description":"Imię","minLength":2,"maxLength":50,"example":"Jan"},"lastName":{"type":"string","description":"Nazwisko","minLength":2,"maxLength":100,"example":"Nowak"},"company":{"type":"string","description":"Firma","minLength":4,"maxLength":200,"nullable":true},"nip":{"type":"string","description":"Nip firmy","nullable":true},"country":{"type":"string","description":"Kraj","minLength":2,"maxLength":2,"nullable":true,"example":"PL"},"city":{"type":"string","description":"Miasto","maxLength":50,"example":"Łuków"},"street":{"type":"string","description":"Ulica","maxLength":60,"example":"Sochacz"},"houseNumber":{"type":"string","description":"Numer domu","maxLength":7,"example":"15"},"flatNumber":{"type":"string","description":"Numer lokalu","maxLength":6},"postCode":{"type":"string","description":"Kod pocztowy","maxLength":10,"example":"21-400"},"phone":{"type":"string","description":"Numer telefonu","minLength":9,"maxLength":15,"example":"123456789"},"email":{"type":"string","description":"Adres email","maxLength":100,"example":"bok@epaka.pl"},"pointId":{"type":"string","description":"Id punkt nadania"},"pointDescription":{"type":"string","description":"Nazwa punkt nadania","maxLength":100}},"required":["name","lastName","country","city","street","houseNumber","postCode","phone","email"]},"ReceiverAddressData":{"type":"object","properties":{"name":{"type":"string","description":"Imię (Dla kuriera InPost Paczkomaty pole opcjonalne)","minLength":2,"maxLength":50,"example":"Jan"},"lastName":{"type":"string","description":"Nazwisko (Dla kuriera InPost Paczkomaty pole opcjonalne)","minLength":2,"maxLength":100,"example":"Nowak"},"company":{"type":"string","description":"Firma","minLength":4,"maxLength":200,"nullable":true},"nip":{"type":"string","description":"Nip firmy","nullable":true},"country":{"type":"string","description":"Kraj (Dla kuriera InPost Paczkomaty pole opcjonalne)","minLength":2,"maxLength":2,"nullable":true,"example":"PL"},"city":{"type":"string","description":"Miasto (Dla kuriera InPost Paczkomaty pole opcjonalne)","maxLength":50,"example":"Łuków"},"street":{"type":"string","description":"Ulica (Dla kuriera InPost Paczkomaty pole opcjonalne)","maxLength":60,"example":"Sochacz"},"houseNumber":{"type":"string","description":"Numer domu (Dla kuriera InPost Paczkomaty pole opcjonalne)","maxLength":7,"example":"15"},"flatNumber":{"type":"string","description":"Numer lokalu (Dla kuriera InPost Paczkomaty pole opcjonalne)","maxLength":6},"postCode":{"type":"string","description":"Kod pocztowy (Dla kuriera InPost Paczkomaty pole opcjonalne)","maxLength":10,"example":"21-400"},"phone":{"type":"string","description":"Numer telefonu","minLength":9,"maxLength":15,"example":"123456789"},"email":{"type":"string","description":"Adres email
Pole wymagane dla:
InPost Kurier (id: 12) - z wybranymi usługami \"infoServiceEmail\" - Serwis e-mail lub labelSendInLocker - Nadanie w paczkomacie z etykietą
InPost Paczkomaty (id: 6)
InPost International (id: 57)
FedEx Punkt (id: 45)
DHL (id: 8) - jeżeli kraj odbioru jest inny niż PL
DHL Servicepoint (id: 22)
DHL Express (id: 23)
Meest (id: 14)
Nova Poshta (id: 53)
","maxLength":100,"example":"bok@epaka.pl"},"pointId":{"type":"string","description":"Id punkt obioru"},"pointDescription":{"type":"string","description":"Nazwa punkt odbioru","maxLength":100}},"required":["name","lastName","country","city","street","houseNumber","postCode","phone"]},"MakeOrderPaymentData":{"type":"object","properties":{"paymentType":{"type":"string","description":"Typ płatności za zamówienie:
online_payment - Płatność online (Przelewy24, Paynow, Paypal)
balance - Płatność saldem
cumulative_payment - Płatność abonametowa
pay_on_delivery - Płatność przy doręczeniu
","default":"online_payment","enum":["online_payment","balance","cumulative_payment","pay_on_delivery"]},"blikCode":{"type":"string","description":"Kod blik"},"paymentOperator":{"type":"string","description":"Operatorzy dla rodzaju płatności: `online_payment`","default":"p24","enum":["blik","p24","paypal"]}},"required":["paymentType"]},"PickupTimeData":{"type":"object","properties":{"from":{"type":"string","description":"Godzina odbioru przesyłki (od) w formacie HH:MM","example":"10:30"},"to":{"type":"string","description":"Godzina odbioru przesyłki (do) w formacie HH:MM","example":"10:30"}},"required":["from","to"]},"CustomsServiceData":{"type":"object","properties":{"purpose":{"type":"string","description":"Przeznaczenie przesyłki:","enum":["gift","not_sold","personal_effects","repair_and_return","sample","sold","documents","return"]},"informationAccept":{"type":"boolean","description":"Zapoznano się z informacjami odnośnie usługi celnej","default":false},"eori":{"type":"string","description":"Numer eori"},"pesel":{"type":"string","description":"Numer pesel"},"hmrc":{"type":"string","description":"Numer hmrc"}}},"OrderServicesData":{"type":"object","properties":{"cod":{"type":"boolean","description":"Usługa pobrania","default":false},"codReturnType":{"type":"string","default":"account","description":"Rodzaj pobrania:
account - Zwrot pobrania na konto bankowe lub saldo
cash - Zwrot pobrania w punkcie epaka.pl
","enum":["account","cash"]},"codReturnPointId":{"type":"string","description":"Id punkt odbioru pobrania (punkt epaka.pl)"},"codType":{"type":"string","description":"Rodzaj pobrania (apiName)","example":"cod.10dr"},"codAmount":{"type":"number","description":"Wartość kwoty pobrania","format":"decimal"},"bankAccount":{"type":"string","description":"Numer konta bankowego do zwrotu pobrania","example":"12345678901234567890123456"},"insurance":{"type":"boolean","description":"Usługa ubezpieczenia","default":false},"declaredValue":{"type":"number","description":"Wartość przesyłki(ubezpieczenia)","format":"decimal"},"additionalServices":{"description":"Lista z identyfikatorami(apiName) wybranych usług dodatkowych","type":"array","items":{"type":"string"}}}},"OrderContent":{"type":"object","properties":{"content":{"type":"string","description":"Informacja o zawartości"},"value":{"type":"number","description":"Wartość zawartości","format":"decimal"},"quantity":{"type":"integer","description":"Ilość sztuk"},"weight":{"type":"number","description":"waga przedmiotu","format":"decimal"},"countryOrigin":{"type":"string","description":"Pochodzenie przedmiotu"},"code":{"type":"string","description":"Kod przedmiotu"}},"required":["content","value","quantity","weight"]},"OrderBody":{"type":"object","properties":{"sender":{"description":"Dane adresowe nadawcy","allOf":[{"$ref":"#/components/schemas/SenderAddressData"}]},"receiver":{"description":"Dane adresowe odbiorcy","allOf":[{"$ref":"#/components/schemas/ReceiverAddressData"}]},"paymentData":{"description":"Dane do płatności","allOf":[{"$ref":"#/components/schemas/MakeOrderPaymentData"}]},"invoiceReceiverData":{"description":"Dane odbiorcy faktury","allOf":[{"$ref":"#/components/schemas/InvoiceReceiverData"}]},"courierId":{"type":"integer","description":"Id kuriera"},"shippingType":{"type":"string","description":"Rodzaj wysyłki:
envelope - Koperta
package - Paczka
pallet - Paleta
tires - Opony
","enum":["envelope","package","pallet","tires"]},"pickupDate":{"type":"string","description":"Data odbioru w standardzie ISO 8601","example":"2024-01-20"},"pickupTime":{"description":"Godzina odbioru przesyłki","allOf":[{"$ref":"#/components/schemas/PickupTimeData"}]},"comments":{"type":"string","description":"Uwagi do zamówienia"},"customsService":{"description":"Dane do obsługi celnej","allOf":[{"$ref":"#/components/schemas/CustomsServiceData"}]},"services":{"description":"Usługi dodatkowe do zamówienia","allOf":[{"$ref":"#/components/schemas/OrderServicesData"}]},"packages":{"description":"Lista z wymiarami przesyłek.
Wymagane dla shippingType: envelope, package, pallet","type":"array","items":{"$ref":"#/components/schemas/PackageData"}},"content":{"type":"string","description":"Zawartość przesyłki (Pole wymagane w przypadku przesyłek nie wymagających odprawy celnej. W przypadku odprawy celnej należy przesłać szczegółową zawartość poprzez parametr `contents`)"},"contents":{"description":"Szczegółowa zawartość - wymagana w przypadku odprawy celnej","type":"array","items":{"$ref":"#/components/schemas/OrderContent"}},"promoCode":{"type":"string","description":"Kod rabatowy"},"tires":{"description":"Parametry opon.
Wymagane dla shippingType: tires","allOf":[{"$ref":"#/components/schemas/TiresData"}]},"filesUploadIds":{"description":"Tablica identyfikatorów tymczasowo zapisanych plików, które mają zostać powiązane z zamówieniem. Każdy element odpowiada jednemu plikowi lub grupie plików wysłanych wcześniej. Należy przekazać te ID podczas składania zamówienia, aby system wiedział, które pliki mają być przypisane.","example":["3fa85f64c9b24caa9e6e8f1b2c3d4e5f","7ab12cd34ef56gh78ij90kl12mn34op56"],"type":"array","items":{"type":"string"}}},"required":["sender","receiver","paymentData","courierId","shippingType","pickupDate","pickupTime","content"]},"ServicePrice":{"type":"object","properties":{"apiName":{"type":"string","description":"Identyfikator usług (apiName)"},"name":{"type":"string","description":"Nazwa usługi"},"grossPrice":{"type":"number","description":"Cenna brutto za usługę","format":"decimal"},"netPrice":{"type":"number","description":"Cenna netto za usługę","format":"decimal"}}},"CheckDataResponse":{"type":"object","properties":{"grossPriceTotal":{"type":"number","description":"Cena brutto przesyłki z usługami oraz kodem rabatowym","format":"decimal"},"servicesGrossPriceTotal":{"type":"number","description":"Cena brutto za wszystkie usługi","format":"decimal"},"priceWithoutDiscount":{"type":"number","description":"Cena za przesyłkę bez kodu rabatowego - zwracana jeżeli został użyty kod rabatowy","format":"decimal"},"lastLowestPrice":{"type":"number","description":"Najniższa cena z ostatnich 30 dni - zwracana jeżeli został użyty kod rabatowy","format":"decimal"},"services":{"description":"Lista wybranych usług dodatkowych wraz ceną","type":"array","items":{"$ref":"#/components/schemas/ServicePrice"}}}},"OrderPaymentData":{"type":"object","properties":{"paymentLink":{"type":"string","description":"Link do płatności w systemie epaka.pl"},"redirectUrl":{"type":"string","description":"Link do przekierowania do systemu operatora płatności (Paypal,Przelewy24)"},"status":{"type":"string","description":"Aktualny status płatności"},"token":{"type":"string","description":"Token do płatności (Przelewy24)"},"provider":{"type":"string","description":"Operator płatności","enum":["p24","blik","paypal"]}}},"OrderResponse":{"type":"object","properties":{"orderId":{"type":"number","description":"Identyfikator utworzonego zamówienia"},"message":{"type":"string","description":"Informację o złożonym zamówieniu"},"orderProcessResult":{"type":"number","description":"Rezultat złożenia zamówienia:
-1 – zamówienie oczekuje na zapłatę i nie zostało jeszcze przekazane firmie kurierskiej
0 – zamówienie zostało zapisane w systemie, ale wystąpił błąd przy przekazaniu go firmie kurierskiej; konieczny kontakt z administratorem serwisu
1 – zamówienie zostało przekazane do firmy kurierskiej, etykiety i protokół są już gotowe
2 – zamówienie zostało przekazane do firmy kurierskiej, ale nie udało się przygotować etykiety i protokołu
4 - zamówienie zostało przekazane do firmy kurierskiej, dla danego zamówienia nie jest generowana etykieta."},"paymentData":{"description":"Dane do płatności","allOf":[{"$ref":"#/components/schemas/OrderPaymentData"}]}}},"ImagesPayload":{"type":"object","properties":{"images":{"description":"Tablica ze zdjęciami paczki.","properties":{"file":{"type":"string","format":"binary"}},"type":"array","items":{"type":"file"}}},"required":["images"]},"CustomsServiceFilesPayload":{"type":"object","properties":{"files":{"description":"Tablica z plikami do wrzucenia.","properties":{"file":{"type":"string","format":"binary"}},"type":"array","items":{"type":"file"}},"type":{"type":"string","description":"Rodzaj przesyłanych dokumentów","enum":["invoice","additionalFiles"]},"courierId":{"type":"int","description":"Identyfikator kuriera"}},"required":["files","type","courierId"]},"AddFilesResponse":{"type":"object","properties":{"filesUploadId":{"type":"string","description":"Identyfikator tymczasowo zapisanych plików (Ważny przez 2h). Należy go przekazać podczas składania zamówienia, aby powiązać pliki z zamówieniem.","example":"3fa85f64c9b24caa9e6e8f1b2c3d4e5f"}}},"FreightSenderData":{"type":"object","properties":{"country":{"type":"string","description":"Kraj","minLength":2,"maxLength":2,"nullable":true,"example":"PL"},"postCode":{"type":"string","description":"Kod pocztowy","maxLength":10,"example":"21-400"},"phone":{"type":"string","description":"Numer telefonu","minLength":9,"maxLength":15,"example":"123456789"},"email":{"type":"string","description":"Adres email","maxLength":100,"example":"bok@epaka.pl"}},"required":["country","postCode","phone","email"]},"FreightReceiverData":{"type":"object","properties":{"country":{"type":"string","description":"Kraj","minLength":2,"maxLength":2,"nullable":true,"example":"PL"},"postCode":{"type":"string","description":"Kod pocztowy","maxLength":10,"example":"21-400"}},"required":["country","postCode"]},"FreightOrderPayload":{"type":"object","properties":{"packages":{"description":"Lista z wymiarami przesyłek.","type":"array","items":{"$ref":"#/components/schemas/PackageData"}},"shippingType":{"type":"string","description":"Rodzaj wysyłki:
envelope - Koperta
package - Paczka
pallet - Paleta
","enum":["envelope","package","pallet"]},"sender":{"description":"Wymagane dane adresowe nadawcy","allOf":[{"$ref":"#/components/schemas/FreightSenderData"}]},"receiver":{"description":"Wymagane dane adresowe odbiorcy","allOf":[{"$ref":"#/components/schemas/FreightReceiverData"}]},"termsAccepted":{"type":"boolean","description":"Akceptacja regulaminu serwisu epaka.pl","default":false}},"required":["packages","shippingType","sender","receiver","termsAccepted"]},"Franchise":{"type":"object","properties":{}},"FranchisesResponse":{"type":"object","properties":{"franchises":{"description":"Lista franczyz","type":"array","items":{"$ref":"#/components/schemas/Franchise"}}}},"InvoiceMetadataDto":{"type":"object","properties":{"invoiceId":{"type":"number","description":"Identyfikator faktury"},"number":{"type":"string","nullable":true,"description":"Numer faktury"},"issueDate":{"format":"date-time","type":"string","nullable":true,"description":"Data wystawienia faktury"},"saleDate":{"format":"date-time","type":"string","nullable":true,"description":"Data sprzedaży"},"dueDate":{"format":"date-time","type":"string","nullable":true,"description":"Termin płatności"},"buyerName":{"type":"string","nullable":true,"description":"Nazwa kupującego"},"buyerTaxId":{"type":"string","nullable":true,"description":"NIP kupującego"},"status":{"type":"string","nullable":true,"description":"Status faktury"},"typeId":{"type":"number","nullable":true,"description":"Id rodzaju faktury"},"declaredItemsCount":{"type":"number","nullable":true,"description":"Deklarowana liczba pozycji"},"itemsCount":{"type":"number","description":"Liczba pozycji"},"correctionsCount":{"type":"number","description":"Liczba korekt"},"infaktStatus":{"type":"string","nullable":true,"description":"Status faktury w Infakt","enum":["sent","created","error","skipped","connection_error"]},"infaktId":{"type":"string","nullable":true,"description":"Id faktury w Infakt"},"infaktAsyncId":{"type":"string","nullable":true,"description":"Id operacji asynchronicznej w Infakt"},"errorCode":{"type":"number","nullable":true,"description":"Kod błędu infakt"},"paymentStatus":{"type":"string","nullable":true,"description":"Status płatności w Infakt","enum":["paid","unpaid"]},"ksefNumber":{"type":"string","nullable":true,"description":"Numer w KSeF"},"ksefStatus":{"type":"string","nullable":true,"description":"Status KSeF","enum":["sent","created","error"]},"ksefErrorCode":{"type":"string","nullable":true,"description":"Kod błędu KSeF"},"ksefErrorMessage":{"type":"string","nullable":true,"description":"Komunikat błędu KSeF"},"otherOperationStatus":{"type":"string","nullable":true,"description":"Status pozostałych operacji","enum":["sent","created","error","skipped","connection_error"]},"otherOperationErrorCode":{"type":"string","nullable":true,"description":"Kod błędu pozostałych operacji"},"otherOperationErrorMessage":{"type":"string","nullable":true,"description":"Komunikat błędu pozostałych operacji"}},"required":["invoiceId","number","issueDate","saleDate","dueDate","buyerName","buyerTaxId","status","typeId","declaredItemsCount","itemsCount","correctionsCount","infaktStatus","infaktId"]},"InvoiceItemDto":{"type":"object","properties":{"id":{"type":"number","description":"Identyfikator pozycji"},"invoiceId":{"type":"number","description":"Identyfikator faktury sprzedaży"},"vatRateId":{"type":"number","description":"Id stawki VAT"},"vatRate":{"type":"string","nullable":true,"description":"Stawka VAT"},"vatRatePercent":{"type":"number","nullable":true,"description":"Stawka VAT w procentach"},"productName":{"type":"string","description":"Nazwa produktu/usługi"},"unitId":{"type":"number","description":"Id jednostki miary"},"unit":{"type":"string","nullable":true,"description":"Nazwa jednostki miary"},"quantity":{"type":"number","description":"Ilość"},"netAmount":{"type":"string","nullable":true,"description":"Kwota netto pozycji"},"vatAmount":{"type":"string","nullable":true,"description":"Kwota VAT pozycji"},"grossAmount":{"type":"string","nullable":true,"description":"Kwota brutto pozycji"},"gtuSymbolId":{"type":"number","nullable":true,"description":"Id symbolu GTU"}},"required":["id","invoiceId","vatRateId","vatRate","vatRatePercent","productName","unitId","unit","quantity","netAmount","vatAmount","grossAmount","gtuSymbolId"]},"InvoicePaymentDto":{"type":"object","properties":{"id":{"type":"number","description":"Identyfikator płatności"},"paymentMethodId":{"type":"number","description":"Id metody płatności"},"paymentMethodName":{"type":"string","nullable":true,"description":"Nazwa metody płatności"},"amount":{"type":"string","description":"Kwota płatności"},"addedDate":{"format":"date-time","type":"string","nullable":true,"description":"Data dodania płatności"},"dueDate":{"format":"date-time","type":"string","nullable":true,"description":"Termin płatności"},"note":{"type":"string","nullable":true,"description":"Notatka do płatności"},"employeeId":{"type":"number","nullable":true,"description":"Id pracownika"}},"required":["id","paymentMethodId","paymentMethodName","amount","addedDate","dueDate","note","employeeId"]},"InvoiceCorrectionDto":{"type":"object","properties":{"id":{"type":"number","description":"Identyfikator korekty (sprzedaz_faktura)"},"number":{"type":"string","nullable":true,"description":"Numer korekty"},"operationType":{"type":"string","description":"Typ operacji korekty","enum":["korekta","korekta_danych"]},"invoiceTypeId":{"type":"number","nullable":true,"description":"Id typu faktury"},"invoiceTypeName":{"type":"string","nullable":true,"description":"Nazwa typu faktury"},"issueDate":{"format":"date-time","type":"string","nullable":true,"description":"Data wystawienia korekty"},"saleDate":{"format":"date-time","type":"string","nullable":true,"description":"Data sprzedaży korekty"},"dueDate":{"format":"date-time","type":"string","nullable":true,"description":"Termin płatności"},"paidDate":{"format":"date-time","type":"string","nullable":true,"description":"Data opłacenia"},"netAmount":{"type":"string","nullable":true,"description":"Kwota netto korekty"},"vatAmount":{"type":"string","nullable":true,"description":"Kwota VAT korekty"},"grossAmount":{"type":"string","nullable":true,"description":"Kwota brutto korekty"},"paidAmount":{"type":"string","nullable":true,"description":"Kwota zapłacona"},"remainingAmount":{"type":"string","nullable":true,"description":"Kwota pozostała"},"paymentStatus":{"type":"string","nullable":true,"description":"Status płatności korekty"},"buyerName":{"type":"string","nullable":true,"description":"Nazwa nabywcy"},"buyerAddress":{"type":"string","nullable":true,"description":"Adres nabywcy"},"buyerPostalCode":{"type":"string","nullable":true,"description":"Kod pocztowy nabywcy"},"buyerCity":{"type":"string","nullable":true,"description":"Miasto nabywcy"},"buyerCountry":{"type":"string","nullable":true,"description":"Kraj nabywcy"},"buyerIdentifierTypeId":{"type":"number","nullable":true,"description":"Id rodzaju identyfikatora nabywcy"},"buyerIdentifier":{"type":"string","nullable":true,"description":"Identyfikator nabywcy (NIP/PESEL/inny)"},"buyerEmail":{"type":"string","nullable":true,"description":"Email nabywcy"},"buyerId":{"type":"number","nullable":true,"description":"Id nabywcy"},"sellerName":{"type":"string","nullable":true,"description":"Nazwa sprzedawcy"},"sellerAddress":{"type":"string","nullable":true,"description":"Adres sprzedawcy"},"sellerPostalCode":{"type":"string","nullable":true,"description":"Kod pocztowy sprzedawcy"},"sellerCity":{"type":"string","nullable":true,"description":"Miasto sprzedawcy"},"sellerIdentifier":{"type":"string","nullable":true,"description":"Identyfikator sprzedawcy"},"sellerEmail":{"type":"string","nullable":true,"description":"Email sprzedawcy"},"sellerAccountNumber":{"type":"string","nullable":true,"description":"Numer konta sprzedawcy"},"initialPaidAmount":{"type":"string","nullable":true,"description":"Kwota zapłacona inicjalnie"},"isPaid":{"type":"number","nullable":true,"description":"Czy zapłacono (flaga)"},"correctionAmount":{"type":"string","nullable":true,"description":"Wartość po korekcie"},"paymentMethodId":{"type":"number","nullable":true,"description":"Id metody płatności"},"paymentMethodName":{"type":"string","nullable":true,"description":"Nazwa metody płatności"},"currencyId":{"type":"number","nullable":true,"description":"Id waluty"},"date":{"format":"date-time","type":"string","nullable":true,"description":"Data dokumentu"},"description":{"type":"string","nullable":true,"description":"Opis"},"pointId":{"type":"number","nullable":true,"description":"Id punktu"},"employeeId":{"type":"number","nullable":true,"description":"Id pracownika"},"numberTemplateId":{"type":"number","nullable":true,"description":"Id szablonu numeracji"},"token":{"type":"string","nullable":true,"description":"Token dokumentu"},"disableLogo":{"type":"number","nullable":true,"description":"Czy wyłączyć logo na fakturze"},"recipientId":{"type":"number","nullable":true,"description":"Id odbiorcy"},"recipientName":{"type":"string","nullable":true,"description":"Nazwa odbiorcy"},"recipientCountry":{"type":"string","nullable":true,"description":"Kraj odbiorcy"},"recipientIdentifierTypeId":{"type":"number","nullable":true,"description":"Id rodzaju identyfikatora odbiorcy"},"recipientIdentifier":{"type":"string","nullable":true,"description":"Identyfikator odbiorcy (NIP/PESEL/inny)"},"recipientPostalCode":{"type":"string","nullable":true,"description":"Kod pocztowy odbiorcy"},"recipientCity":{"type":"string","nullable":true,"description":"Miasto odbiorcy"},"recipientAddress":{"type":"string","nullable":true,"description":"Adres odbiorcy"},"recipientEmail":{"type":"string","nullable":true,"description":"Email odbiorcy"},"cashMethod":{"type":"number","nullable":true,"description":"Czy metoda kasowa"},"items":{"description":"Pozycje korekty","type":"array","items":{"$ref":"#/components/schemas/InvoiceItemDto"}},"payments":{"description":"Płatności korekty","type":"array","items":{"$ref":"#/components/schemas/InvoicePaymentDto"}},"infaktStatus":{"type":"string","nullable":true,"description":"Status faktury w Infakt","enum":["sent","created","error","skipped","connection_error"]},"infaktId":{"type":"string","nullable":true,"description":"Id faktury w Infakt"},"infaktAsyncId":{"type":"string","nullable":true,"description":"Id operacji asynchronicznej w Infakt"},"errorCode":{"type":"number","nullable":true,"description":"Kod błędu infakt"},"ksefNumber":{"type":"string","nullable":true,"description":"Numer w KSeF"},"ksefStatus":{"type":"string","nullable":true,"description":"Status KSeF","enum":["sent","created","error"]},"ksefErrorCode":{"type":"string","nullable":true,"description":"Kod błędu KSeF"},"ksefErrorMessage":{"type":"string","nullable":true,"description":"Komunikat błędu KSeF"},"otherOperationStatus":{"type":"string","nullable":true,"description":"Status pozostałych operacji","enum":["sent","created","error","skipped","connection_error"]},"otherOperationErrorCode":{"type":"string","nullable":true,"description":"Kod błędu pozostałych operacji"},"otherOperationErrorMessage":{"type":"string","nullable":true,"description":"Komunikat błędu pozostałych operacji"}},"required":["id","number","operationType","invoiceTypeId","invoiceTypeName","issueDate","saleDate","dueDate","paidDate","netAmount","vatAmount","grossAmount","paidAmount","remainingAmount","paymentStatus","buyerName","buyerAddress","buyerPostalCode","buyerCity","buyerCountry","buyerIdentifierTypeId","buyerIdentifier","buyerEmail","buyerId","sellerName","sellerAddress","sellerPostalCode","sellerCity","sellerIdentifier","sellerEmail","sellerAccountNumber","initialPaidAmount","isPaid","correctionAmount","paymentMethodId","paymentMethodName","currencyId","date","description","pointId","employeeId","numberTemplateId","token","disableLogo","recipientId","recipientName","recipientCountry","recipientIdentifierTypeId","recipientIdentifier","recipientPostalCode","recipientCity","recipientAddress","recipientEmail","cashMethod","items","payments","infaktStatus","infaktId"]},"InvoiceDocumentDto":{"type":"object","properties":{"id":{"type":"number","description":"Identyfikator faktury"},"number":{"type":"string","nullable":true,"description":"Numer faktury"},"invoiceTypeId":{"type":"number","nullable":true,"description":"Id typu faktury"},"invoiceTypeName":{"type":"string","nullable":true,"description":"Nazwa typu faktury"},"buyerId":{"type":"number","description":"Id nabywcy"},"buyerName":{"type":"string","nullable":true,"description":"Nazwa nabywcy"},"buyerAddress":{"type":"string","nullable":true,"description":"Adres nabywcy"},"buyerPostalCode":{"type":"string","nullable":true,"description":"Kod pocztowy nabywcy"},"buyerCity":{"type":"string","nullable":true,"description":"Miasto nabywcy"},"buyerCountry":{"type":"string","nullable":true,"description":"Kraj nabywcy"},"buyerIdentifierTypeId":{"type":"number","description":"Id rodzaju identyfikatora nabywcy"},"buyerIdentifier":{"type":"string","description":"Identyfikator nabywcy (NIP/PESEL/inny)"},"buyerEmail":{"type":"string","nullable":true,"description":"Email nabywcy"},"sellerName":{"type":"string","nullable":true,"description":"Nazwa sprzedawcy"},"sellerAddress":{"type":"string","nullable":true,"description":"Adres sprzedawcy"},"sellerPostalCode":{"type":"string","nullable":true,"description":"Kod pocztowy sprzedawcy"},"sellerCity":{"type":"string","nullable":true,"description":"Miasto sprzedawcy"},"sellerIdentifier":{"type":"string","nullable":true,"description":"Identyfikator sprzedawcy"},"sellerEmail":{"type":"string","nullable":true,"description":"Email sprzedawcy"},"sellerAccountNumber":{"type":"string","nullable":true,"description":"Numer konta sprzedawcy"},"issueDate":{"format":"date-time","type":"string","nullable":true,"description":"Data wystawienia faktury"},"saleDate":{"format":"date-time","type":"string","nullable":true,"description":"Data sprzedaży"},"dueDate":{"format":"date-time","type":"string","nullable":true,"description":"Termin płatności"},"paidDate":{"format":"date-time","type":"string","nullable":true,"description":"Data opłacenia"},"netAmount":{"type":"string","nullable":true,"description":"Kwota netto"},"vatAmount":{"type":"string","nullable":true,"description":"Kwota VAT"},"grossAmount":{"type":"string","nullable":true,"description":"Kwota brutto"},"paidAmount":{"type":"string","nullable":true,"description":"Kwota zapłacona"},"remainingAmount":{"type":"string","nullable":true,"description":"Kwota pozostała do zapłaty"},"initialPaidAmount":{"type":"string","nullable":true,"description":"Kwota zapłacona inicjalnie"},"paymentStatus":{"type":"string","nullable":true,"description":"Status płatności"},"isPaid":{"type":"number","nullable":true,"description":"Czy zapłacono (flaga)"},"correctionAmount":{"type":"string","nullable":true,"description":"Wartość po korekcie"},"paymentMethodId":{"type":"number","nullable":true,"description":"Id metody płatności"},"paymentMethodName":{"type":"string","nullable":true,"description":"Nazwa metody płatności"},"currencyId":{"type":"number","nullable":true,"description":"Id waluty"},"date":{"format":"date-time","type":"string","nullable":true,"description":"Data dokumentu"},"description":{"type":"string","nullable":true,"description":"Opis"},"pointId":{"type":"number","nullable":true,"description":"Id punktu"},"employeeId":{"type":"number","nullable":true,"description":"Id pracownika"},"numberTemplateId":{"type":"number","nullable":true,"description":"Id szablonu numeracji"},"token":{"type":"string","nullable":true,"description":"Token dokumentu"},"disableLogo":{"type":"number","description":"Czy wyłączyć logo na fakturze"},"recipientId":{"type":"number","nullable":true,"description":"Id odbiorcy"},"recipientName":{"type":"string","nullable":true,"description":"Nazwa odbiorcy"},"recipientCountry":{"type":"string","nullable":true,"description":"Kraj odbiorcy"},"recipientIdentifierTypeId":{"type":"number","nullable":true,"description":"Id rodzaju identyfikatora odbiorcy"},"recipientIdentifier":{"type":"string","nullable":true,"description":"Identyfikator odbiorcy (NIP/PESEL/inny)"},"recipientPostalCode":{"type":"string","nullable":true,"description":"Kod pocztowy odbiorcy"},"recipientCity":{"type":"string","nullable":true,"description":"Miasto odbiorcy"},"recipientAddress":{"type":"string","nullable":true,"description":"Adres odbiorcy"},"recipientEmail":{"type":"string","nullable":true,"description":"Email odbiorcy"},"cashMethod":{"type":"number","description":"Czy metoda kasowa"},"items":{"description":"Pozycje faktury","type":"array","items":{"$ref":"#/components/schemas/InvoiceItemDto"}},"payments":{"description":"Płatności faktury","type":"array","items":{"$ref":"#/components/schemas/InvoicePaymentDto"}},"corrections":{"description":"Korekty faktury","type":"array","items":{"$ref":"#/components/schemas/InvoiceCorrectionDto"}},"infaktStatus":{"type":"string","nullable":true,"description":"Status faktury w Infakt","enum":["sent","created","error","skipped","connection_error"]},"infaktId":{"type":"string","nullable":true,"description":"Id faktury w Infakt"},"infaktAsyncId":{"type":"string","nullable":true,"description":"Id operacji asynchronicznej w Infakt"},"errorCode":{"type":"number","nullable":true,"description":"Kod błędu infakt"},"ksefNumber":{"type":"string","nullable":true,"description":"Numer w KSeF"},"ksefStatus":{"type":"string","nullable":true,"description":"Status KSeF","enum":["sent","created","error"]},"ksefErrorCode":{"type":"string","nullable":true,"description":"Kod błędu KSeF"},"ksefErrorMessage":{"type":"string","nullable":true,"description":"Komunikat błędu KSeF"},"otherOperationStatus":{"type":"string","nullable":true,"description":"Status pozostałych operacji","enum":["sent","created","error","skipped","connection_error"]},"otherOperationErrorCode":{"type":"string","nullable":true,"description":"Kod błędu pozostałych operacji"},"otherOperationErrorMessage":{"type":"string","nullable":true,"description":"Komunikat błędu pozostałych operacji"}},"required":["id","number","invoiceTypeId","invoiceTypeName","buyerId","buyerName","buyerAddress","buyerPostalCode","buyerCity","buyerCountry","buyerIdentifierTypeId","buyerIdentifier","buyerEmail","sellerName","sellerAddress","sellerPostalCode","sellerCity","sellerIdentifier","sellerEmail","sellerAccountNumber","issueDate","saleDate","dueDate","paidDate","netAmount","vatAmount","grossAmount","paidAmount","remainingAmount","initialPaidAmount","paymentStatus","isPaid","correctionAmount","paymentMethodId","paymentMethodName","currencyId","date","description","pointId","employeeId","numberTemplateId","token","disableLogo","recipientId","recipientName","recipientCountry","recipientIdentifierTypeId","recipientIdentifier","recipientPostalCode","recipientCity","recipientAddress","recipientEmail","cashMethod","items","payments","corrections","infaktStatus","infaktId"]},"InvoiceDataResponseDto":{"type":"object","properties":{"metadata":{"description":"Metadane faktury","allOf":[{"$ref":"#/components/schemas/InvoiceMetadataDto"}]},"document":{"description":"Dokument faktury","allOf":[{"$ref":"#/components/schemas/InvoiceDocumentDto"}]},"items":{"description":"Pozycje faktury","type":"array","items":{"$ref":"#/components/schemas/InvoiceItemDto"}},"corrections":{"description":"Korekty faktury","type":"array","items":{"$ref":"#/components/schemas/InvoiceCorrectionDto"}}},"required":["metadata","document","items","corrections"]},"UpdateStatusInfaktDto":{"type":"object","properties":{"invoiceId":{"type":"number","description":"Identyfikator faktury"},"statusInfakt":{"type":"string","nullable":true,"description":"Status faktury w Infakt","enum":["sent","created","error","skipped","connection_error"]},"idInfakt":{"type":"string","nullable":true,"description":"Id faktury w Infakt"},"infaktAsyncId":{"type":"string","nullable":true,"description":"Id operacji asynchronicznej w Infakt"},"errorCode":{"type":"string","nullable":true,"description":"Kod błędu"},"errorMessage":{"type":"string","nullable":true,"description":"Komunikat błędu"},"paymentStatus":{"type":"string","enum":["PAID","UNPAID"],"nullable":true,"description":"Status płatności"},"downloadLink":{"type":"string","nullable":true,"description":"Link do pobrania faktury"},"linkExpirationDate":{"format":"date-time","type":"string","nullable":true,"description":"Data wygaśnięcia linku do pobrania faktury"},"ksefNumber":{"type":"string","nullable":true,"description":"Numer w KSeF"},"ksefStatus":{"type":"string","nullable":true,"description":"Status KSeF","enum":["sent","created","error","skipped","connection_error"]},"ksefErrorCode":{"type":"string","nullable":true,"description":"Kod błędu KSeF"},"ksefErrorMessage":{"type":"string","nullable":true,"description":"Komunikat błędu KSeF"},"otherOperationStatus":{"type":"string","nullable":true,"description":"Status pozostałych operacji","enum":["sent","created","error","skipped","connection_error"]},"otherOperationErrorCode":{"type":"string","nullable":true,"description":"Kod błędu pozostałych operacji"},"otherOperationErrorMessage":{"type":"string","nullable":true,"description":"Komunikat błędu pozostałych operacji"}},"required":["invoiceId"]},"InvoicePdfDto":{"type":"object","properties":{"documentId":{"type":"number","example":"ID documentu w epaka","description":"ID dokumentu w epaka"},"pointId":{"type":"number","example":"ID punktu sprzedaży","description":"ID punktu sprzedaży"},"invoiceUuid":{"type":"string","example":"ID faktury w inFakt","description":"ID faktury w inFakt"},"content":{"type":"string","description":"Zawartość pliku PDF zakodowana w Base64"},"contentType":{"type":"string","example":"application/pdf","description":"Typ zawartości"},"filename":{"type":"string","example":"faktura_123.pdf","description":"Sugerowana nazwa pliku"}},"required":["documentId","pointId","invoiceUuid","content","contentType","filename"]},"InfaktSendInvoiceToKsefDto":{"type":"object","properties":{"request_created_at":{"type":"string","example":"2023-10-01 16:00:00 +0200","description":"Data utworzenia żądania wysyłki do KSeF"},"request_finished_at":{"type":"string","example":null,"nullable":true,"description":"Data zakończenia przetwarzania żądania wysyłki do KSeF"}},"required":["request_created_at"]},"InfaktKsefDataDto":{"type":"object","properties":{"request_uuid":{"type":"string","example":"a0df6cfb-8c86-42f0-b319-9e4e937d31ed","description":"UUID żądania w KSeF"},"ksef_number":{"type":"string","example":"7251372323-20260331-6E0A66000000-FA","nullable":true,"description":"Numer KSeF nadany po poprawnym przetworzeniu dokumentu"},"status":{"type":"string","example":"success","description":"Status dokumentu w KSeF","enum":["pending","sent","success","error"]},"status_description":{"type":"string","example":null,"nullable":true,"description":"Opis statusu dokumentu w KSeF"},"timestamps":{"description":"Znaczniki czasu","allOf":[{"$ref":"#/components/schemas/InfaktSendInvoiceToKsefDto"}]}},"required":["request_uuid","status","timestamps"]},"InfaktInvoiceServiceDto":{"type":"object","properties":{"id":{"type":"number","example":398755,"description":"ID pozycji"},"name":{"type":"string","example":"Przykładowa Usługa","description":"Nazwa pozycji"},"taxSymbol":{"type":"string","example":"23","description":"Symbol stawki VAT"},"unit":{"type":"string","example":"szt","description":"Jednostka miary"},"quantity":{"type":"number","example":1,"description":"Ilość"},"unitNetPrice":{"type":"number","example":6623,"description":"Cena jednostkowa netto"},"netPrice":{"type":"number","example":6623,"description":"Kwota netto"},"grossPrice":{"type":"number","example":8146,"description":"Kwota brutto"},"taxPrice":{"type":"number","example":1523,"description":"Kwota VAT"},"symbol":{"type":"string","example":"84.11.12.0 / - / -","nullable":true,"description":"Symbol PKWiU/CN/PKOB"},"pkwiu":{"type":"string","example":"84.11.12.0","nullable":true,"description":"Kod PKWiU"},"cn":{"type":"string","example":null,"nullable":true,"description":"Kod CN"},"pkob":{"type":"string","example":null,"nullable":true,"description":"Kod PKOB"},"discount":{"type":"string","example":"0.0","description":"Rabat"},"unitNetPriceBeforeDiscount":{"type":"number","example":6623,"description":"Cena jednostkowa netto przed rabatem"},"gtuId":{"type":"number","example":null,"nullable":true,"description":"ID GTU"},"relatedId":{"type":"number","example":null,"nullable":true,"description":"ID powiązanej pozycji"}},"required":["id","name","taxSymbol","quantity","unitNetPrice","netPrice","grossPrice","taxPrice","discount","unitNetPriceBeforeDiscount"]},"InfaktInvoiceExtensionsDto":{"type":"object","properties":{"payments":{"type":"object","description":"Informacje o płatnościach online"},"shares":{"type":"object","description":"Informacje o linku do podglądu faktury"}},"required":["payments","shares"]},"InfaktInvoiceDto":{"type":"object","properties":{"id":{"type":"number","example":291344,"description":"ID dokumentu w inFakt"},"uuid":{"type":"string","example":"433f9b9f-bfe3-4cab-a7a1-bbbc97a11213","description":"UUID dokumentu w inFakt"},"parentId":{"type":"number","example":null,"nullable":true,"description":"ID dokumentu nadrzędnego"},"number":{"type":"string","example":"544/03/2026","description":"Numer dokumentu"},"currency":{"type":"string","example":"PLN","description":"Waluta"},"paidPrice":{"type":"number","example":0,"description":"Kwota zapłacona"},"notes":{"type":"string","example":null,"nullable":true,"description":"Notatki"},"kind":{"type":"string","example":"vat","description":"Rodzaj dokumentu (vat, margin, correction, …)"},"paymentMethod":{"type":"string","example":"cash","description":"Metoda płatności"},"splitPayment":{"type":"boolean","example":false,"description":"Podzielona płatność"},"splitPaymentType":{"type":"string","example":null,"nullable":true,"description":"Typ podzielonej płatności"},"recipientSignature":{"type":"string","example":"","description":"Podpis odbiorcy"},"sellerSignature":{"type":"string","example":"Jan Kowalski","description":"Podpis sprzedawcy"},"invoiceDate":{"type":"string","example":"2026-03-19","description":"Data wystawienia (YYYY-MM-DD)"},"saleDate":{"type":"string","example":"2026-03-19","description":"Data sprzedaży (YYYY-MM-DD)"},"vatDateValue":{"type":"string","example":"sale_date","description":"Podstawa daty VAT"},"continuousServiceStartOn":{"type":"string","example":null,"nullable":true,"description":"Początek usługi ciągłej"},"continuousServiceEndOn":{"type":"string","example":null,"nullable":true,"description":"Koniec usługi ciągłej"},"occasionalSale":{"type":"boolean","example":false,"description":"Sprzedaż okazjonalna"},"status":{"type":"string","example":"printed","description":"Status dokumentu"},"paymentDate":{"type":"string","example":"2026-04-02","description":"Termin płatności (YYYY-MM-DD)"},"paidDate":{"type":"string","example":null,"nullable":true,"description":"Data opłacenia (YYYY-MM-DD)"},"netPrice":{"type":"number","example":6623,"description":"Kwota netto"},"taxPrice":{"type":"number","example":1523,"description":"Kwota VAT"},"grossPrice":{"type":"number","example":8146,"description":"Kwota brutto"},"leftToPay":{"type":"number","example":8146,"description":"Pozostało do zapłaty"},"clientId":{"type":"number","example":124086,"description":"ID klienta w inFakt"},"clientUuid":{"type":"string","example":"1d3aa0f9-21e4-47b9-ac1c-a4ff2be0fec2","description":"UUID klienta w inFakt"},"clientCompanyName":{"type":"string","example":"INFAKT Sp. z o.o.","description":"Nazwa firmy klienta"},"clientFirstName":{"type":"string","example":null,"nullable":true,"description":"Imię klienta"},"clientLastName":{"type":"string","example":null,"nullable":true,"description":"Nazwisko klienta"},"clientBusinessActivityKind":{"type":"string","example":null,"nullable":true,"description":"Rodzaj działalności klienta"},"clientStreet":{"type":"string","example":null,"nullable":true,"description":"Ulica klienta"},"clientStreetNumber":{"type":"string","example":null,"nullable":true,"description":"Numer budynku klienta"},"clientFlatNumber":{"type":"string","example":null,"nullable":true,"description":"Numer mieszkania klienta"},"clientCity":{"type":"string","example":null,"nullable":true,"description":"Miasto klienta"},"clientPostCode":{"type":"string","example":null,"nullable":true,"description":"Kod pocztowy klienta"},"clientTaxCode":{"type":"string","example":"","description":"NIP klienta"},"clientCountry":{"type":"string","example":"PL","description":"Kraj klienta (ISO 3166-1 alpha-2)"},"bankAccount":{"type":"string","example":"PL872490285246981455432347847211","description":"Numer konta bankowego"},"bankName":{"type":"string","example":"Alior Bank S.A.","description":"Nazwa banku"},"swift":{"type":"string","example":"ALBPPLPWXXX","description":"Kod SWIFT/BIC"},"vatExemptionReason":{"type":"string","example":null,"nullable":true,"description":"Podstawa zwolnienia z VAT"},"saleType":{"type":"string","example":"","description":"Typ sprzedaży"},"invoiceDateKind":{"type":"string","example":"sale_date","description":"Rodzaj daty faktury"},"documentMarkingsIds":{"example":[],"description":"ID oznaczeń dokumentu","type":"array","items":{"type":"number"}},"transactionKindId":{"type":"number","example":null,"nullable":true,"description":"ID rodzaju transakcji"},"bdoCode":{"type":"string","example":null,"nullable":true,"description":"Kod BDO"},"receiptNumber":{"type":"string","example":null,"nullable":true,"description":"Numer paragonu"},"notIncome":{"type":"boolean","example":false,"description":"Czy nie jest przychodem"},"vatExchangeDateKind":{"type":"string","example":null,"nullable":true,"description":"Rodzaj daty kursu waluty VAT"},"salesKind":{"type":"string","example":"sprzedaz_podstawowa","description":"Rodzaj sprzedaży"},"amountInWords":{"type":"string","example":"osiemdziesiąt jeden PLN 46/100","description":"Kwota słownie"},"localGovernmentRecipientAddress":{"type":"object","nullable":true,"description":"Adres odbiorcy JST"},"buildingService":{"type":"boolean","example":false,"description":"Usługa budowlana"},"createdAt":{"type":"string","example":"2026-03-19T14:27:00.005+01:00","description":"Data utworzenia rekordu"},"reconciliationId":{"type":"number","example":null,"nullable":true,"description":"ID rozliczenia"},"ksefData":{"nullable":true,"description":"Dane KSeF","allOf":[{"$ref":"#/components/schemas/InfaktKsefDataDto"}]},"localGovernmentSellerAddress":{"type":"object","nullable":true,"description":"Adres sprzedawcy JST"},"services":{"description":"Pozycje faktury","type":"array","items":{"$ref":"#/components/schemas/InfaktInvoiceServiceDto"}},"relatedDocuments":{"description":"Powiązane dokumenty","type":"array","items":{"type":"object"}},"extensions":{"description":"Rozszerzenia (linki, płatności)","allOf":[{"$ref":"#/components/schemas/InfaktInvoiceExtensionsDto"}]}},"required":["id","uuid","number","currency","paidPrice","kind","paymentMethod","splitPayment","recipientSignature","sellerSignature","invoiceDate","saleDate","vatDateValue","occasionalSale","status","paymentDate","netPrice","taxPrice","grossPrice","leftToPay","clientId","clientUuid","clientCompanyName","clientTaxCode","clientCountry","notIncome","buildingService","createdAt"]},"InfaktCorrectiveInvoiceServiceDto":{"type":"object","properties":{"id":{"type":"number","example":398755,"description":"ID pozycji"},"name":{"type":"string","example":"Przykładowa Usługa","description":"Nazwa pozycji"},"taxSymbol":{"type":"string","example":"23","description":"Symbol stawki VAT"},"unit":{"type":"string","example":"szt","description":"Jednostka miary"},"quantity":{"type":"number","example":1,"description":"Ilość"},"unitNetPrice":{"type":"number","example":6623,"description":"Cena jednostkowa netto"},"netPrice":{"type":"number","example":6623,"description":"Kwota netto"},"grossPrice":{"type":"number","example":8146,"description":"Kwota brutto"},"taxPrice":{"type":"number","example":1523,"description":"Kwota VAT"},"symbol":{"type":"string","example":"84.11.12.0 / - / -","nullable":true,"description":"Symbol PKWiU/CN/PKOB"},"pkwiu":{"type":"string","example":"84.11.12.0","nullable":true,"description":"Kod PKWiU"},"cn":{"type":"string","example":null,"nullable":true,"description":"Kod CN"},"pkob":{"type":"string","example":null,"nullable":true,"description":"Kod PKOB"},"discount":{"type":"string","example":"0.0","description":"Rabat"},"unitNetPriceBeforeDiscount":{"type":"number","example":6623,"description":"Cena jednostkowa netto przed rabatem"},"gtuId":{"type":"number","example":null,"nullable":true,"description":"ID GTU"},"relatedId":{"type":"number","example":null,"nullable":true,"description":"ID powiązanej pozycji"},"group":{"type":"number","example":1,"description":"Numer grupy (paruje pozycję oryginalną z korygującą)"},"correction":{"type":"boolean","example":true,"description":"Czy pozycja jest korygująca (true) czy korygowana (false)"}},"required":["id","name","taxSymbol","quantity","unitNetPrice","netPrice","grossPrice","taxPrice","discount","unitNetPriceBeforeDiscount","group","correction"]},"InfaktCorrectiveInvoiceDto":{"type":"object","properties":{"id":{"type":"number","example":291344,"description":"ID dokumentu w inFakt"},"uuid":{"type":"string","example":"433f9b9f-bfe3-4cab-a7a1-bbbc97a11213","description":"UUID dokumentu w inFakt"},"parentId":{"type":"number","example":null,"nullable":true,"description":"ID dokumentu nadrzędnego"},"number":{"type":"string","example":"544/03/2026","description":"Numer dokumentu"},"currency":{"type":"string","example":"PLN","description":"Waluta"},"paidPrice":{"type":"number","example":0,"description":"Kwota zapłacona"},"notes":{"type":"string","example":null,"nullable":true,"description":"Notatki"},"kind":{"type":"string","example":"vat","description":"Rodzaj dokumentu (vat, margin, correction, …)"},"paymentMethod":{"type":"string","example":"cash","description":"Metoda płatności"},"splitPayment":{"type":"boolean","example":false,"description":"Podzielona płatność"},"splitPaymentType":{"type":"string","example":null,"nullable":true,"description":"Typ podzielonej płatności"},"recipientSignature":{"type":"string","example":"","description":"Podpis odbiorcy"},"sellerSignature":{"type":"string","example":"Jan Kowalski","description":"Podpis sprzedawcy"},"invoiceDate":{"type":"string","example":"2026-03-19","description":"Data wystawienia (YYYY-MM-DD)"},"saleDate":{"type":"string","example":"2026-03-19","description":"Data sprzedaży (YYYY-MM-DD)"},"vatDateValue":{"type":"string","example":"sale_date","description":"Podstawa daty VAT"},"continuousServiceStartOn":{"type":"string","example":null,"nullable":true,"description":"Początek usługi ciągłej"},"continuousServiceEndOn":{"type":"string","example":null,"nullable":true,"description":"Koniec usługi ciągłej"},"occasionalSale":{"type":"boolean","example":false,"description":"Sprzedaż okazjonalna"},"status":{"type":"string","example":"printed","description":"Status dokumentu"},"paymentDate":{"type":"string","example":"2026-04-02","description":"Termin płatności (YYYY-MM-DD)"},"paidDate":{"type":"string","example":null,"nullable":true,"description":"Data opłacenia (YYYY-MM-DD)"},"netPrice":{"type":"number","example":6623,"description":"Kwota netto"},"taxPrice":{"type":"number","example":1523,"description":"Kwota VAT"},"grossPrice":{"type":"number","example":8146,"description":"Kwota brutto"},"leftToPay":{"type":"number","example":8146,"description":"Pozostało do zapłaty"},"clientId":{"type":"number","example":124086,"description":"ID klienta w inFakt"},"clientUuid":{"type":"string","example":"1d3aa0f9-21e4-47b9-ac1c-a4ff2be0fec2","description":"UUID klienta w inFakt"},"clientCompanyName":{"type":"string","example":"INFAKT Sp. z o.o.","description":"Nazwa firmy klienta"},"clientFirstName":{"type":"string","example":null,"nullable":true,"description":"Imię klienta"},"clientLastName":{"type":"string","example":null,"nullable":true,"description":"Nazwisko klienta"},"clientBusinessActivityKind":{"type":"string","example":null,"nullable":true,"description":"Rodzaj działalności klienta"},"clientStreet":{"type":"string","example":null,"nullable":true,"description":"Ulica klienta"},"clientStreetNumber":{"type":"string","example":null,"nullable":true,"description":"Numer budynku klienta"},"clientFlatNumber":{"type":"string","example":null,"nullable":true,"description":"Numer mieszkania klienta"},"clientCity":{"type":"string","example":null,"nullable":true,"description":"Miasto klienta"},"clientPostCode":{"type":"string","example":null,"nullable":true,"description":"Kod pocztowy klienta"},"clientTaxCode":{"type":"string","example":"","description":"NIP klienta"},"clientCountry":{"type":"string","example":"PL","description":"Kraj klienta (ISO 3166-1 alpha-2)"},"bankAccount":{"type":"string","example":"PL872490285246981455432347847211","description":"Numer konta bankowego"},"bankName":{"type":"string","example":"Alior Bank S.A.","description":"Nazwa banku"},"swift":{"type":"string","example":"ALBPPLPWXXX","description":"Kod SWIFT/BIC"},"vatExemptionReason":{"type":"string","example":null,"nullable":true,"description":"Podstawa zwolnienia z VAT"},"saleType":{"type":"string","example":"","description":"Typ sprzedaży"},"invoiceDateKind":{"type":"string","example":"sale_date","description":"Rodzaj daty faktury"},"documentMarkingsIds":{"example":[],"description":"ID oznaczeń dokumentu","type":"array","items":{"type":"number"}},"transactionKindId":{"type":"number","example":null,"nullable":true,"description":"ID rodzaju transakcji"},"bdoCode":{"type":"string","example":null,"nullable":true,"description":"Kod BDO"},"receiptNumber":{"type":"string","example":null,"nullable":true,"description":"Numer paragonu"},"notIncome":{"type":"boolean","example":false,"description":"Czy nie jest przychodem"},"vatExchangeDateKind":{"type":"string","example":null,"nullable":true,"description":"Rodzaj daty kursu waluty VAT"},"salesKind":{"type":"string","example":"sprzedaz_podstawowa","description":"Rodzaj sprzedaży"},"amountInWords":{"type":"string","example":"osiemdziesiąt jeden PLN 46/100","description":"Kwota słownie"},"localGovernmentRecipientAddress":{"type":"object","nullable":true,"description":"Adres odbiorcy JST"},"buildingService":{"type":"boolean","example":false,"description":"Usługa budowlana"},"createdAt":{"type":"string","example":"2026-03-19T14:27:00.005+01:00","description":"Data utworzenia rekordu"},"reconciliationId":{"type":"number","example":null,"nullable":true,"description":"ID rozliczenia"},"ksefData":{"nullable":true,"description":"Dane KSeF","allOf":[{"$ref":"#/components/schemas/InfaktKsefDataDto"}]},"correctedInvoiceNumber":{"type":"string","example":"296/03/2026","description":"Numer korygowanej faktury"},"correctedInvoiceDate":{"type":"string","example":"2026-03-18","description":"Data korygowanej faktury (YYYY-MM-DD)"},"confirmation":{"type":"boolean","example":false,"description":"Potwierdzenie odbioru korekty"},"confirmationDate":{"type":"string","example":"","description":"Data potwierdzenia odbioru korekty"},"correctionReason":{"type":"string","example":"Inne: np. zwrot, rabat","description":"Powód korekty"},"correctionReasonSymbol":{"type":"string","example":"other","description":"Symbol powodu korekty"},"checkCorrectionObligation":{"type":"boolean","example":true,"description":"Czy należy sprawdzić obowiązek korekty"},"services":{"description":"Pozycje korekty","type":"array","items":{"$ref":"#/components/schemas/InfaktCorrectiveInvoiceServiceDto"}}},"required":["id","uuid","number","currency","paidPrice","kind","paymentMethod","splitPayment","recipientSignature","sellerSignature","invoiceDate","saleDate","vatDateValue","occasionalSale","status","paymentDate","netPrice","taxPrice","grossPrice","leftToPay","clientId","clientUuid","clientCompanyName","clientTaxCode","clientCountry","notIncome","buildingService","createdAt","correctedInvoiceNumber","correctedInvoiceDate","confirmation","confirmationDate","correctionReason","correctionReasonSymbol","checkCorrectionObligation","services"]}}},"x-tagGroups":[{"name":" ","tags":["Dokumentacja WebAPI(XML)","Autoryzacja"]},{"name":"Dane użytkownika","tags":["Profil","Płatności","Faktury","Zamówienia","Książka adresowa","Powiadomienia","Karty płatnicze","Szablony"]},{"name":"Zamów kuriera","tags":["Zamów kuriera","Punkty nadań/obioru","Kurierzy","Kraje","Koszyk","Wycena indywidualna"]},{"name":"Inne","tags":["Tracking","Inne"]}]}