Dokumentacja

Dokumentacja przedstawia krok po kroku jak w prosty i szybki sposób skomunikować
Twój sklep z Comfino.

Spis treści

Dodawanie punktu sprzedaży usług

Dodaje nowy punkt sprzedaży usług. Każdy wpis o danym numerze NIP jest unikalny. Nie można dodać do bazy kilku wpisów o takim samym numerze NIP.

Zapytanie: | Zapytanie jest sprawdzane pod kątem poprawności przesyłanych wartości

curl -X POST 'http://{HOST_API}/v1/sale-points' \
--header 'API-KEY: {API-KEY}' \
--header 'Content-Type: application/json' \
--data-raw '{
  "name": "{nazwa dostawcy usługi}",
  "taxId": "{NIP usługodawcy}",
  "city": "{miejscowość usługodawcy}",
  "accountNumber": "{numer konta usługodawcy}",
  "contactPerson": "{dane osoby do kontaktu}",
  "productTypes": [{lista typów produktów dostępnych dla punktu sprzedaży}]
}'

Definicja pól:

Nazwa pola Typ Wymagane Format
name string tak Znaki alfanumeryczne (max. 100)
taxId string tak Znaki alfanumeryczne (max. 10)
city string tak Znaki alfanumeryczne (max. 50)
accountNumber string tak Znaki alfanumeryczne (max. 50)
contactPerson string nie Znaki alfanumeryczne (max. 50)
productTypes string[] nie Tablica wartosci slownikowych - zobacz sekcje typy produktow finansowych w dokumentacji wartosci slownikowych.

Odpowiedź:

{
    "name": "{nazwa dostawcy usługi}",
    "taxId": "{NIP usługodawcy}",
    "active": true,
    "city": "{miejscowość usługodawcy}",
    "accountNumber": "{numer konta usługodawcy}",
    "contactPerson": "{dane osoby do kontaktu}",
    "productTypes": [{lista typów produktów dostępnych dla punktu sprzedaży}]
}

Kody odpowiedzi:

  • 201 Created
  • 400 Bad Request
  • 401 Unauthorized
  • 403 Http Forbidden
  • 404 Http Not Found
  • 405 Method Not Allowed
  • 500 Internal Server Error