Skip to main content
POST
/
v1
/
api
/
superadmin
/
reservations
/
{id}
/
cancel
Cancel a reservation with refund
curl --request POST \
  --url http://localhost:3091/v1/api/superadmin/reservations/{id}/cancel \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reason": "<string>",
  "fullRefund": true,
  "partialRefundAmount": 123,
  "adminNotes": "<string>"
}
'
{
  "id": 123,
  "reservationNumber": "<string>",
  "idCreateur": 123,
  "idExpediteur": 123,
  "statut": "<string>",
  "annonceId": 123,
  "poidsReserve": 123,
  "expediteur": {
    "id": 123,
    "firstName": "<string>",
    "lastName": "<string>",
    "username": "<string>",
    "phoneNumber": "<string>",
    "nationality": "<string>",
    "birthDate": "<string>",
    "email": "<string>",
    "stripeConnectedAccountId": "<string>",
    "enabled": true,
    "walletBalance": 123,
    "pendingWithdrawalAmount": 123,
    "totalEarned": 123,
    "totalWithdrawn": 123
  },
  "createurProfil": {
    "id": 123,
    "firstName": "<string>",
    "lastName": "<string>",
    "username": "<string>",
    "phoneNumber": "<string>",
    "nationality": "<string>",
    "birthDate": "<string>",
    "email": "<string>",
    "stripeConnectedAccountId": "<string>",
    "enabled": true,
    "walletBalance": 123,
    "pendingWithdrawalAmount": 123,
    "totalEarned": 123,
    "totalWithdrawn": 123
  },
  "createur": "<string>",
  "lieuArrivee": "<string>",
  "lieuDepart": "<string>",
  "dateDepart": "2023-12-25",
  "dateArrivee": "2023-12-25",
  "annonce": "<string>",
  "codeDepot": "<string>",
  "createurEmail": "<string>",
  "infosContenu": "<string>",
  "codeLivraison": "<string>",
  "pointRdv": "<string>",
  "pointLivraison": "<string>",
  "paymentId": "<string>",
  "authorizationId": "<string>",
  "captureId": "<string>",
  "refundId": "<string>",
  "paymentStatus": "<string>",
  "paymentDate": "2023-11-07T05:31:56Z",
  "paymentApprovalUrl": "<string>",
  "reservationDate": "2023-11-07T05:31:56Z",
  "items": [
    {
      "categorieId": 123,
      "nom": "<string>",
      "quantiteReserve": 123,
      "code": "<string>"
    }
  ],
  "invoiceId": "<string>",
  "invoiceUrl": "<string>",
  "invoiceStatus": "<string>"
}

Authorizations

Authorization
string
header
required

JWT access token from POST /v1/api/auth/login

Path Parameters

id
integer<int32>
required

Body

application/json
reason
string
required
fullRefund
boolean
partialRefundAmount
number<double>
adminNotes
string

Response

Reservation cancelled

id
integer<int32>
reservationNumber
string
idCreateur
integer<int32>
idExpediteur
integer<int32>
statut
string
annonceId
integer<int32>
poidsReserve
number<double>
expediteur
object
createurProfil
object
createur
string
lieuArrivee
string
lieuDepart
string
dateDepart
string<date>
dateArrivee
string<date>
annonce
string
codeDepot
string
createurEmail
string
infosContenu
string
codeLivraison
string
pointRdv
string
pointLivraison
string
paymentId
string
authorizationId
string
captureId
string
refundId
string
paymentStatus
string
paymentDate
string<date-time>
paymentApprovalUrl
string
reservationDate
string<date-time>
items
object[]
invoiceId
string
invoiceUrl
string
invoiceStatus
string