Statusy zamówień

Struktura danych JSON

Obiekt OrderStatus

  • id – (readonly) ID w bazie danych
  • name – nazwa statusu zamówień
  • color – kolor HEX (jak w HTML tylko z pominięciem znaku hash #), max 8 znaków

Pobieranie wszystkich statusów zamówień

GET

/order_statuses

Odpowiedź JSON - zawiera tablicę obiektów OrderStatus
{
    "orderStatuses": [
        ...
    ]
}

Pobieranie statusu zamówienia

GET

/order_statuses

Parametry w ścieżce zapytania
  • id – ID statusu
/order_statuses?id=1
Odpowiedź JSON
{
    "id": 1,
    "name": "Nazwa statusu",
    "color": "00ff00"
}

Dodawanie statusu zamówienia

POST

/order_statuses

Dane JSON w zapytaniu (body)

Należy przekazać obiekt OrderStatus. Pola readonly są pomijane, nie trzeba ich przekazywać.

Dane odpowiedzi JSON

W odpowiedzi zwrócony zostanie nowo utworzony obiekt OrderStatus zawierający ID.

Edycja statusu zamówienia

PUT

/order_statuses

Dane JSON w zapytaniu (body)

Należy przekazać pełny obiekt OrderStatus do edycji (wraz z ID do edycji).

Dane odpowiedzi JSON

W odpowiedzi zwrócony zostanie obiekt OrderStatus.

Usuwanie statusów zamówień

DELETE

/order_statuses

Parametry w ścieżce zapytania
  • id – ID statusu do usunięcia
/order_statuses?id=1
Odpowiedź - 204 No Content