Pobierz listę produktów

Zakres: api:invoices:read. Sortowanie po name, chyba że podano order.

Filtry i order na unit_net_price i unit_net_price_before_discount są ignorowane; na symbol używają pkwiu, a na tax_symbol i flat_rate_tax_symbol porównują wewnętrzne id stawki, nie symbol. fields z symbol, unit_net_price lub unit_net_price_before_discount powoduje 500.

GET

https://api.sandbox-infakt.pl/v3/products.json

Autoryzacja

ApiKey
opcjonalne
API key in header

Token
opcjonalne
API key in header

Query parameters

page
opcjonalne
integer
Numer strony liczony od 1; ignorowany, gdy wysłany jest offset.

format: int32 · default: 1
per_page
opcjonalne
integer
Liczba wyników na stronę przy page. Serwer jej nie ogranicza.

format: int32 · default: 10
offset
opcjonalne
integer
Indeks pierwszego wyniku (liczba pomijanych encji).

format: int32
limit
opcjonalne
integer
Liczba wyników na stronę przy offset; domyślnie 10, ignorowana bez offset. Większość list bez błędu obniża wartości powyżej 100 do 100.

format: int32
pagination_without_total
opcjonalne
boolean
Pomiń liczenie; metainfo.total_count przyjmuje wartość null.
fields
opcjonalne
string
Zawężenie pól: nazwy pól API rozdzielone przecinkami, np. id,company_name; id jest zwykle dodawane. Odpowiedź zawiera wtedy tylko te pola, więc nie odpowiada pełnemu schematowi. Pola wyliczane, a nie zapisywane, mogą kończyć się błędem 500; operacja je wymienia.
order
opcjonalne
string
Sortowanie: <pole>, <pole> asc albo <pole> desc z nazwą pola API, np. name desc. Pole, po którym nie da się sortować, jest ignorowane bez błędu.
q[name_eq]
opcjonalne
string
Nazwa równa.
q[name_cont]
opcjonalne
string
Nazwa zawiera.
q[pkwiu_eq]
opcjonalne
string
Kod PKWiU równy.
q[cn_eq]
opcjonalne
string
Kod CN równy.
q[gtin_eq]
opcjonalne
string
GTIN równy.
q[unit_eq]
opcjonalne
string
Jednostka równa, np. szt..

Odpowiedzi

200

Sukces

JSON

metainfo
object
wymagane
- count
  integer
  wymagane
  Liczba encji na tej stronie.
  
  format: int32
- total_count
  wymagane
  Liczba pasujących encji; null, gdy pagination_without_total=true.
  
  One of the following:
  integer
  null
- next
  string
  wymagane
  Bezwzględny URL następnej strony w postaci offset/limit.
- previous
  string
  wymagane
  Bezwzględny URL poprzedniej strony w postaci offset/limit.
}
entities
array of
object
wymagane
- id
  integer
  wymagane
  format: int64
- uuid
  string
  wymagane
  format: uuid
- name
  string
  wymagane
- symbol
  wymagane
  Klasyfikacja drukowana na dokumentach. Gdy ustawiono pkwiu, cn lub pkob, ma postać pkwiu / cn / pkob z - w miejscu każdego brakującego kodu, np. 234 / - / -.
  
  One of the following:
  string
  null
- pkwiu
  wymagane
  Kod PKWiU dla KSeF.
  
  One of the following:
  string
  null
- cn
  wymagane
  Kod CN dla KSeF.
  
  One of the following:
  string
  null
- pkob
  wymagane
  Kod PKOB dla KSeF.
  
  One of the following:
  string
  null
- gtin
  wymagane
  One of the following:
  string
  null
- unit
  wymagane
  Jednostka miary, np. szt..
  
  One of the following:
  string
  null
- tax_symbol
  string
  wymagane
  Symbol stawki VAT, np. 23, 8, zw. Zobacz GET /vat_rates.json.
- flat_rate_tax_symbol
  string
  wymagane
  Symbol stawki ryczałtu; "", gdy nie ustawiono.
- quantity
  number
  wymagane
  format: double
- net_price
  integer
  wymagane
  Kwota w groszach (1/100 PLN). 12300 oznacza 123,00 PLN.
  
  format: int64
- tax_price
  integer
  wymagane
  Kwota w groszach (1/100 PLN). 12300 oznacza 123,00 PLN.
  
  format: int64
- gross_price
  integer
  wymagane
  Kwota w groszach (1/100 PLN). 12300 oznacza 123,00 PLN.
  
  format: int64
- unit_net_price
  integer
  wymagane
  Kwota w groszach (1/100 PLN). 12300 oznacza 123,00 PLN.
  
  format: int64
- purchase_unit_net_price
  integer
  wymagane
  Kwota w groszach (1/100 PLN). 12300 oznacza 123,00 PLN.
  
  format: int64
- purchase_unit_gross_price
  integer
  wymagane
  Kwota w groszach (1/100 PLN). 12300 oznacza 123,00 PLN.
  
  format: int64
- discount
  string
  wymagane
  Rabat w procentach.
  
  pattern: ^-?\d+(\.\d+)?$
- unit_net_price_before_discount
  integer
  wymagane
  Kwota w groszach (1/100 PLN). 12300 oznacza 123,00 PLN.
  
  format: int64
- vat_exemption_reason
  wymagane
  Id podstawy zwolnienia z VAT. Zobacz GET /vat_exemptions.json.
  
  One of the following:
  integer
  null
- gtu_id
  wymagane
  Id kodu GTU. Zobacz GET /gtus.json.
  
  One of the following:
  integer
  null
}

400

Nieprawidłowe parametry wyszukiwania (q[...]); na niektórych endpointach także nieprawidłowe parametry stronicowania.

JSON

error
opcjonalne
Komunikat po polsku (po angielsku dla 429). Niektóre akcje zamiast jednego tekstu zwracają listę komunikatów albo błędy walidacji według pól.
One of the following:
string
array<string>
object
}
errors
opcjonalne
Błędy walidacji według nazw pól API; na niektórych endpointach zwykły komunikat.
One of the following:
object
string
}
limit
opcjonalne
string
Kod limitu planu, np. limit_exceeded, plan_upgrade_needed, cant_add_client.
type
opcjonalne
redirect
or
email_not_confirmed
url
opcjonalne
string
action_url
opcjonalne
string

401

Brak klucza API, nieprawidłowy klucz albo klucz bez wymaganego zakresu uprawnień.

JSON

error
opcjonalne
Komunikat po polsku (po angielsku dla 429). Niektóre akcje zamiast jednego tekstu zwracają listę komunikatów albo błędy walidacji według pól.
One of the following:
string
array<string>
object
}
errors
opcjonalne
Błędy walidacji według nazw pól API; na niektórych endpointach zwykły komunikat.
One of the following:
object
string
}
limit
opcjonalne
string
Kod limitu planu, np. limit_exceeded, plan_upgrade_needed, cant_add_client.
type
opcjonalne
redirect
or
email_not_confirmed
url
opcjonalne
string
action_url
opcjonalne
string

402

API niedostępne w obecnym planie (limit: plan_upgrade_needed) albo osiągnięty limit dokumentów.

JSON

error
opcjonalne
Komunikat po polsku (po angielsku dla 429). Niektóre akcje zamiast jednego tekstu zwracają listę komunikatów albo błędy walidacji według pól.
One of the following:
string
array<string>
object
}
errors
opcjonalne
Błędy walidacji według nazw pól API; na niektórych endpointach zwykły komunikat.
One of the following:
object
string
}
limit
opcjonalne
string
Kod limitu planu, np. limit_exceeded, plan_upgrade_needed, cant_add_client.
type
opcjonalne
redirect
or
email_not_confirmed
url
opcjonalne
string
action_url
opcjonalne
string

406

Ścieżka nie kończy się na .json.

JSON

error
opcjonalne
Komunikat po polsku (po angielsku dla 429). Niektóre akcje zamiast jednego tekstu zwracają listę komunikatów albo błędy walidacji według pól.
One of the following:
string
array<string>
object
}
errors
opcjonalne
Błędy walidacji według nazw pól API; na niektórych endpointach zwykły komunikat.
One of the following:
object
string
}
limit
opcjonalne
string
Kod limitu planu, np. limit_exceeded, plan_upgrade_needed, cant_add_client.
type
opcjonalne
redirect
or
email_not_confirmed
url
opcjonalne
string
action_url
opcjonalne
string

423

Niepotwierdzony adres e-mail albo wymagana weryfikacja tożsamości.

JSON

error
opcjonalne
Komunikat po polsku (po angielsku dla 429). Niektóre akcje zamiast jednego tekstu zwracają listę komunikatów albo błędy walidacji według pól.
One of the following:
string
array<string>
object
}
errors
opcjonalne
Błędy walidacji według nazw pól API; na niektórych endpointach zwykły komunikat.
One of the following:
object
string
}
limit
opcjonalne
string
Kod limitu planu, np. limit_exceeded, plan_upgrade_needed, cant_add_client.
type
opcjonalne
redirect
or
email_not_confirmed
url
opcjonalne
string
action_url
opcjonalne
string

429

Przekroczony limit zapytań. Komunikat jest po angielsku, np. API rate limit exceeded. Try again in 60 seconds.

JSON

error
opcjonalne
Komunikat po polsku (po angielsku dla 429). Niektóre akcje zamiast jednego tekstu zwracają listę komunikatów albo błędy walidacji według pól.
One of the following:
string
array<string>
object
}
errors
opcjonalne
Błędy walidacji według nazw pól API; na niektórych endpointach zwykły komunikat.
One of the following:
object
string
}
limit
opcjonalne
string
Kod limitu planu, np. limit_exceeded, plan_upgrade_needed, cant_add_client.
type
opcjonalne
redirect
or
email_not_confirmed
url
opcjonalne
string
action_url
opcjonalne
string

{ "metainfo": { "count": 1, "total_count": 1, "next": "https://api.infakt.pl/v3/products.json?q%5Bname_cont%5D=Macbook&offset=10&limit=10", "previous": "https://api.infakt.pl/v3/products.json?q%5Bname_cont%5D=Macbook&offset=0&limit=10" }, "entities": [ { "id": 1007, "uuid": "c41f7a2d-9b3e-4d58-a6c1-0e7b2f9d3a85", "name": "Macbook Pro", "symbol": "234 / - / -", "pkwiu": "234", "cn": null, "pkob": null, "gtin": null, "unit": "szt.", "tax_symbol": "23", "flat_rate_tax_symbol": "", "quantity": 1, "net_price": 406423, "tax_price": 93477, "gross_price": 499900, "unit_net_price": 406423, "purchase_unit_net_price": 350000, "purchase_unit_gross_price": 430500, "discount": "0.0", "unit_net_price_before_discount": 406423, "vat_exemption_reason": null, "gtu_id": null } ] }