Dokumentacja

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

Pobieranie listy wszystkich punktów sprzedaży usług

Zwraca wszystkie punkty sprzedaży usług.

Zapytanie:

curl -X GET https://{HOST_API}/v1/sale-points \
-H "Content-Type: application/json" \
-H "Api-Key: {API-KEY}"

Odpowiedź:

{
    "records": [
        {
            "name": "{nazwa dostawcy usługi 1}",
            "taxId": "{NIP usługodawcy 1}",
            "active": {status aktywności punktu 1 - true/false},
            "city": "{miejscowość usługodawcy 1}",
            "accountNumber": "{numer konta usługodawcy 1}",
            "contactPerson": "{imię osoby do kontaktu 1}",
            "productTypes": [{lista typów produktów dostępnych dla punktu sprzedaży 1}],
            "_links": {
                "self": {
                    "href": "https://{HOST_API}/v1/sale-points/{NIP usługodawcy 1}",
                    "method": "GET"
                }
            }
        },
        {
            "name": "{nazwa dostawcy usługi 2}",
            "taxId": "{NIP usługodawcy 2}",
            "active": {status aktywności punktu 2 - true/false},
            "city": "{miejscowość usługodawcy 2}",
            "accountNumber": "{numer konta usługodawcy 2}",
            "contactPerson": "{dane osoby do kontaktu 2}",
            "productTypes": [{lista typów produktów dostępnych dla punktu sprzedaży 2}],
            "_links": {
                "self": {
                    "href": "https://{HOST_API}/v1/sale-points/{NIP usługodawcy 2}",
                    "method": "GET"
                }
            }
        },
        {
            "name": "{nazwa dostawcy usługi n}",
            "taxId": "{NIP usługodawcy n}",
            "active": {true/false},
            "city": "{miejscowość usługodawcy n}",
            "accountNumber": "{numer konta usługodawcy n}",
            "contactPerson": "{dane osoby do kontaktu n}",
            "productTypes": [{lista typów produktów dostępnych dla punktu sprzedaży n}],
            "_links": {
                "self": {
                    "href": "https://{HOST_API}/v1/sale-points/{NIP usługodawcy n}",
                    "method": "GET"
                }
            }
        }
    ],
    "_links": {
        "add": {
            "href": "https://{HOST_API}/v1/sale-points",
            "method": "POST"
        }
    }
}

Kody odpowiedzi:

  • 200 OK
  • 401 Unauthorized
  • 405 Method Not Allowed
  • 500 Internal Server Error