3 API3.6
3.6
Wyszukiwanie w katalogu: GET /catalogue/{code}
Wyszukanie jednego kodu z katalogu.
- W sandboxie
Prostymi słowami
To wywołanie wyjaśnia prostymi słowami jeden kod błędu: co jest nie tak, co zrobić i kto ma zareagować.
GET /catalogue/{code} zwraca publiczną część jednego wpisu z katalogu. Każde ustalenie w raporcie i każdy błąd w odpowiedzi 422 ma jeden z tych kodów. Wywołanie wymaga klucza z zakresem read. Kodem może być także jeden z jego aliasów.
| Pole | Znaczenie |
|---|---|
id | Kod. |
meaning | Co jest nie tak. |
fix | Co z tym zrobić. |
owner | Kto reaguje: us albo jeden z pozostałych podmiotów wymienionych na stronie Błędy i katalog. |
severity | error, business, warning lub info. |
routes | Kanały, których dotyczy kod. ALL oznacza wszystkie kanały. |
partner_message | Zdanie, które wysłalibyśmy klientowi. Dla niektórych kodów jest dostępne w kilku językach. |
curl "https://api-sandbox-eu.eurinvoice.com/catalogue/EI-SCHEMA" \
-H "Authorization: Bearer <your-api-key>"import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class Example {
public static void main(String[] args) throws Exception {
HttpRequest request = HttpRequest.newBuilder(URI.create("https://api-sandbox-eu.eurinvoice.com/catalogue/EI-SCHEMA"))
.header("Authorization", "Bearer <your-api-key>")
.GET()
.build();
HttpResponse<String> response = HttpClient.newHttpClient()
.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode());
System.out.println(response.body());
}
}const response = await fetch('https://api-sandbox-eu.eurinvoice.com/catalogue/EI-SCHEMA', {
headers: {
Authorization: 'Bearer <your-api-key>',
},
});
console.log(response.status);
console.log(await response.text());{
"severity": "error",
"owner": "us",
"routes": [
"ALL"
],
"partner_message": "We could not read this invoice from your export. We are correcting our mapping; if a field is missing in the ERP we will tell you which one.",
"fix": "Read the JSON path in the error and correct the client mapping.",
"meaning": "The invoice JSON does not match the canonical model: a missing or unknown field, a wrong type or code, or a route rule on structure.",
"id": "EI-SCHEMA"
}Dla kodu, którego nie ma w katalogu, odpowiedzią jest 404.
curl "https://api-sandbox-eu.eurinvoice.com/catalogue/NO-SUCH-CODE" \
-H "Authorization: Bearer <your-api-key>"import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class Example {
public static void main(String[] args) throws Exception {
HttpRequest request = HttpRequest.newBuilder(URI.create("https://api-sandbox-eu.eurinvoice.com/catalogue/NO-SUCH-CODE"))
.header("Authorization", "Bearer <your-api-key>")
.GET()
.build();
HttpResponse<String> response = HttpClient.newHttpClient()
.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode());
System.out.println(response.body());
}
}const response = await fetch('https://api-sandbox-eu.eurinvoice.com/catalogue/NO-SUCH-CODE', {
headers: {
Authorization: 'Bearer <your-api-key>',
},
});
console.log(response.status);
console.log(await response.text());{
"detail": "NO-SUCH-CODE",
"type": "https://eurinvoice.com/problems/not-found",
"title": "No such catalogue entry",
"status": 404
}Odpowiedzi
| Status | Znaczenie |
|---|---|
200 | Wpis. |
401 | Brak klucza lub nieznany klucz. |
403 | Klucz nie ma zakresu read. |
404 | Brak takiego wpisu w katalogu. |
429 | Zbyt wiele żądań dla klucza. Należy odczekać liczbę sekund podaną w Retry-After. |