Zamówienia – pobieranie listy cech produktów
Metoda GET zwraca pełną listę cech produktów skonfigurowanych na Twoim koncie ECDP w sekcji Ustawienia > Zamówienia > Cechy produktów.
Endpoint
GET productattributes
Host: https://api.ecdp.app
Parametry zapytania
| Parametr | Lokalizacja | Typ | Wymagany | Opis | Dozwolone wartości / Uwagi |
| x-api-key | header | string | tak | Twój klucz API do uwierzytelnienia w ECDP. | Znajdziesz go w Ustawienia > API. |
Ten endpoint nie wymaga żadnych parametrów w zapytaniu. Odpowiedź zawiera wszystkie cechy produktów skonfigurowane w twojej jednostce biznesowej.
Odpowiedź
Odpowiedź zawiera wskaźnik statusu oraz tablicę obiektów cech produktów.
| Parametr | Typ | Opis |
| status | integer ($int32) | Kod statusu odpowiedzi. Dla udanych zapytań zwraca wartość 0. |
| data | array | Tablica z danymi cech produktów. Jeśli żadne cechy nie zostały skonfigurowane – zwraca pustą tablicę. Szczegóły struktury znajdziesz w sekcji Zobacz Product attribute data. |
Product attribute data
Każdy element w tablicy data reprezentuje pojedynczą cechę produktu i zawiera następujące parametry:
| Parametr | Typ | Opis |
| id | integer (int32) | Unikalny identyfikator cechy produktu. Odpowiada ID widocznemu w Ustawienia > Zamówienia > Cechy produktów. |
| name | string | Nazwa wyświetlana cechy, nadana podczas jej tworzenia. Maksymalnie 256 znaków. |
| type | string | Typ danych cechy. Określa, jakie wartości można przechowywać i jak są one walidowane. Zobacz Data types. |
Data types
Pole type może przyjmować jedną z poniższych wartości:
| Typ | Opis |
| String | Krótka wartość tekstowa – zazwyczaj do 255 znaków. |
| Text | Długi tekst. |
| Number | Wartość liczbowa (całkowita lub dziesiętna). |
| Money | Wartość walutowa z precyzją dziesiętną. |
| Date | Data bez komponentu czasu (YYYY-MM-DD). |
| DateTime | Data i czas w formacie ISO-8601. |
| SingleSelect | Pojedynczy wybór ze zdefiniowanej listy opcji. |
| Boolean | Wartość logiczna true/false. |
| Url | Poprawny ciąg znaków URL. |
Kody odpowiedzi
| Kod | Status | Opis |
| 200 | OK | Zapytanie przetworzone pomyślnie. Ciało odpowiedzi zawiera dane cech. |
| 401 | Unauthorized | Brak klucza API, klucz jest nieprawidłowy lub nie ma uprawnień do tego zasobu. |
Przykładowe zapytania i odpowiedzi
Pobranie wszystkich cech produktów
GET /productattributes
Odpowiedź (200 OK):
{
"status": 0,
"data": [
{
"id": 1,
"name": "Producent",
"type": "String"
},
{
"id": 2,
"name": "Produkt sezonowy",
"type": "Boolean"
},
{
"id": 3,
"name": "Data premiery",
"type": "Date"
},
{
"id": 4,
"name": "Cena hurtowa",
"type": "Money"
}
]
}Odpowiedź, gdy nie skonfigurowano żadnych cech
{
"status": 0,
"data": []
}Walidacja i zasady działania
- Cechy produktów muszą być wcześniej skonfigurowane w Ustawienia > Zamówienia > Cechy produktów – dopiero wtedy pojawią się w odpowiedzi.
- Wartości id są stabilne i można ich używać do mapowania w integracjach.
- Pusta tablica data oznacza, że nie skonfigurowano żadnych cech produktów.
Dokumentacja referencyjna
Swagger – sekcja Customer attributes