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-point-list \
-H "Content-Type: application/json" \
-H "Api-Key: {API-KEY}"

Odpowiedź:

{
    "records": [
        {
            "name": "{nazwa_dostawcy_usługi_1}",
            "taxId": "{NIP usługodawcy_1}",
            "active": {1/0},
            "city": "{miasto_usługodawcy_1}",
            "accountNumber": "{numer_konta_usługodawcy_1}",
            "contactPerson": "{imię_osoby_do_kontaktu_1}",
            "_links": {
                "deactivate": {
                    "href": "http://{HOST_API}/v1/sale-point/{NIP usługodawcy_1}/deactivate",
                    "method": "PUT"
                }
                "self": {
                    "href": "http://{HOST_API}/v1/sale-point/{NIP usługodawcy_1}",
                    "method": "GET"
                }
            }
        },
        {
            "name": "{nazwa_dostawcy_usługi_2}",
            "taxId": "{NIP usługodawcy_2}",
            "active": {1/0},
            "city": "{miasto_usługodawcy_2}",
            "accountNumber": "{numer_konta_usługodawcy_2}",
            "contactPerson": "{imię_osoby_do_kontaktu_2}",
            "_links": {
                "deactivate": {
                    "href": "http://{HOST_API}/v1/sale-point/{NIP usługodawcy_2}/deactivate",
                    "method": "PUT"
                }
                "self": {
                    "href": "http://{HOST_API}/v1/sale-point/{NIP usługodawcy_2}",
                    "method": "GET"
                }
            }
        },
        {
            "name": "{nazwa_dostawcy_usługi_n}",
            "taxId": "{NIP usługodawcy_n}",
            "active": {1/0},
            "city": "{miasto_usługodawcy_n}",
            "accountNumber": "{numer_konta_usługodawcy_n}",
            "contactPerson": "{imię_osoby_do_kontaktu_n}",
            "_links": {
                "deactivate": {
                    "href": "http://{HOST_API}/v1/sale-point/{NIP usługodawcy_n}/deactivate",
                    "method": "PUT"
                }
                "self": {
                    "href": "http://{HOST_API}/v1/sale-point/{NIP usługodawcy_n}",
                    "method": "GET"
                }
            }
        }
    ],
    "_links": {
        "add": {
            "href": "http://api-ecommerce.comfino.localhost/v1/sale-point-add",
            "method": "POST"
        }
    }
}

Kody odpowiedzi:

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