API – zmiana statusów zamówienia

Endpoint /order-status służy do zmiany statusu zamówienia.

Specyfikacja PATCH – zmiana statusu zamówienia

HTTP PATCH https://drinks2cash.com/api/order-status/ {id} Authorization: <api_key_dystrybutora>
Body:

{
    "status": "string" 
}

Id to numer zamówienia. Swój api_key znajdziesz na stronie: https://drinks2cash.com/order/admin-importer Możliwe wartości dla pola status to:

NEW - nowe
RECEIVED_BY_DISTRIBUTOR - otrzymane przez dystrybutora
IN_REALIZATION - w realizacji
REALIZED - wysłane
CANCELLED - anulowane
WAITING_FOR_CLIENT_CONFIRMATION - oczekujące na potwierdzenie przez klienta  (występuje, gdy zamówienie zostało zmodyfikowane przez dystrybutora)
RETURN - zwrot
COMPLAIN - reklamacja

UWAGA!

1. Zmiana statusu na zrealizowane u niektórych dystrybutorów wymaga wczytania faktury, jeśli tak jest to zwrócony zostanie komunikat błędu.
2. Jeśli zamówienie ma status Anulowane lub Zrealizowane, to nie można już zmienić jego statusu na inny.
3. Jeśli status zostanie zmieniony na Anulowane, to punkty lojalnościowe za to zamówienie zostaną usunięte.

---

Responses

HTTP 200 – OK Body:

{
    "code": 200,
    "reasonPhrase": "OK",
    "data": "Status changed"
}

HTTP 403 – Forbidden Kod 403 to błąd autoryzacji. Body:

{
    "code": 403,
    "reasonPhrase": "Forbidden",
    "data": "Unauthorised"
}

Nie zidentyfikowano użytkownika. Sprawdź, czy podałeś poprawne api_key, znajdziesz je w swoim panelu administracyjnym w zakładce https://drinks2cash.com/order/admin-importer
HTTP 400 – Bad request Błędne parametry żądania.

Przykład 1:

{
    "code": 400,
    "reasonPhrase": "Bad Request",
    "message": "You cannot change status cancelled or realised to any other."
}

Przykład 2:

{
    "code": 400,
    "reasonPhrase": "Bad Request",
    "message": {
        "status": {
            "notInArray": "Status not valid, possible values are: NEW, IN_REALIZATION, RECEIVED_BY_DISTRIBUTOR, REALIZED, CANCELLED, WAITING_FOR_CLIENT_CONFIRMATION, RETURN, COMPLAIN"
        }
    }
}

Przykład 3

{
    "code": 400,
    "reasonPhrase": "Bad Request",
    "message": {
        "id": {
            "noRecordFound": "Order not found"
        }
    }
}