16 października 2023
Zamówienia - zmiany wspierające obsługę bonów dla konkretnego przedmiotu
Wdrożyliśmy możliwość dodawania bonów do konkretnych przedmiotów w procesie zakupowym, dzięki czemu kupujący będzie mógł skorzystać z akcji "Bon 2500 zł na laptopa dla nauczycieli", a w przyszłości również z innych. Do obsługi takich zamówień konieczne są zmiany w API, dlatego wprowadziliśmy zmiany w:
- GET /order/checkout-forms - lista zamówień,
- GET /order/checkout-forms/{id} - szczegóły zamówienia.
Co zmieniliśmy?
Do tablicy obiektów "lineItems[]" dodaliśmy tablicę "vouchers[]":
...
"lineItems": [
...
"vouchers": [
{
"code": "Code12345",
"type": "NOTEBOOKS_FOR_TEACHERS",
"status": "ACTIVE",
"externalTransactionId": "sampleExternalTransactionId",
"value": {
"amount": "123.45",
"currency": "PLN"
}
}
]
...
]
...
gdzie zwrócimy:
- kod bonu, który użył kupujący,
- rodzaj bonu - w tej chwili dostępna jest tylko jedna wartość "NOTEBOOKS_FOR_TEACHERS" - akcja dofinansowania 2500zł na laptop dla nauczycieli,
- status - dostępne wartości:
- “ACTIVE” - aktywny, gotowy do użycia,
- ”CANCELLED” - anulowany, wyłączony z użycia,
- externalTransactionId - zewnętrzny identyfikator transakcji dla bonu, pozwalający w jednoznaczny sposób zidentyfikować wykorzystanie bonu. Wartość może różnić się w zależności od statusu.
- obiekt value - całkowita wartość wykorzystanego bonu.
Jeśli nie dostosujesz swojej aplikacji, sprzedający, którzy będą brać udział w akcji nie otrzymają, z poziomu Twojej aplikacji, kodu potrzebnego do rozliczenia bonu.