Zamówienia – pobieranie listy cech zamówień
Metoda GET zwraca wszystkie cechy zamówień skonfigurowane w Twoim ECDP business unicie w Ustawienia > Zamówienia > Cechy zamówień.
Endpoint
Endpoint, czyli adres serwera dla tego zapytania to https://api.ecdp.app/orderattributes
Parametry zapytania
| Parametr | Lokalizacja | Typ | Wymagany | Opis | Dozwolone wartości / Uwagi |
| x-api-key | header | string | tak | Klucz API do uwierzytelniania. Znajdziesz go w Ustawienia > API. | Musi być prawidłowym kluczem API ECDP. |
Ten endpoint nie przyjmuje żadnych parametrów ani treści zapytania. Jedynym wymaganym elementem jest klucz API w nagłówku.
Odpowiedź
Odpowiedź zawiera następujące parametry:
| Parametr | Typ | Opis |
| status | integer | Kod statusu odpowiedzi. Wartość 0 oznacza sukces. |
| data | array | Tablica z cechami zamówień. Pusta tablica, jeśli nie skonfigurowano żadnych cech. Zobacz Order attribute data. |
Order attribute data
Każdy obiekt w tablicy data zawiera następujące parametry:
| Parametr | Typ | Opis |
| id | integer ($int32) | Unikalny identyfikator cechy zamówienia. Widoczny w Ustawienia > Zamówienia > Cechy zamówień. |
| name | string | Nazwa cechy widoczna w Ustawienia > Zamówienia > Cechy zamówień. Maksymalnie 256 znaków. |
| type | string | Typ danych – określa, jakie wartości może przechowywać dana cecha. Zobacz Data types. |
Data types
Pole type zwraca jedną z poniższych wartości:
| Wartość | Opis |
| String | Krótkie pole tekstowe – zwykle do 255 znaków. |
| Text | Długie pole tekstowe do rozbudowanych treści. |
| 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 z komponentem czasu (format ISO-8601). |
| SingleSelect | Predefiniowana lista dozwolonych wartości. |
| Boolean | Wartość logiczna true/false. |
| Url | Prawidłowy ciąg znaków URL. |
Kody odpowiedzi
| Kod | Opis |
| 200 | Sukces. Zwraca listę cech zamówień (może być pusta). |
| 401 | Brak autoryzacji. Brakuje klucza API, jest nieprawidłowy lub nie ma uprawnień do tego zasobu. |
| 403 | Zabronione. Klucz API nie ma dostępu do tego business unitu. |
| 500 | Wewnętrzny błąd serwera. Na serwerze wystąpił nieoczekiwany błąd. |
Przykładowe zapytania i odpowiedzi
Pobieranie wszystkich cech zamówień
Zapytanie:
GET /productattributes
Odpowiedź (200 OK):
{
"status": 0,
"data": [
{
"id": 1,
"name": "Metoda płatności",
"type": "SingleSelect"
},
{
"id": 2,
"name": "Przewoźnik",
"type": "String"
},
{
"id": 3,
"name": "Uwagi do zamówienia",
"type": "Text"
},
{
"id": 4,
"name": "Na prezent",
"type": "Boolean"
},
{
"id": 5,
"name": "Przewidywana dostawa",
"type": "Date"
}
]
}Odpowiedź, gdy nie dodano żadnych cech zamówień
{
"status": 0,
"data": []
}Walidacja i zasady działania
- Cechy produktów muszą być wcześniej skonfigurowane w Ustawienia > Zamówienia > Cechy zamówień – 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 Order attributes