Skip to main content
PUT
/
v1
/
api
/
bookings
/
{bookingId}
/
deposit-code
Validate deposit code
curl --request PUT \
  --url http://localhost:3091/v1/api/bookings/{bookingId}/deposit-code \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "code": "<string>"
}
'
{
  "id": 123,
  "reservationNumber": "<string>",
  "announcementId": 123,
  "senderId": 123,
  "carrierId": 123,
  "status": "<string>",
  "reservedWeight": 123,
  "contentInfo": "<string>",
  "depositCode": "<string>",
  "deliveryCode": "<string>",
  "departureCity": "<string>",
  "arrivalCity": "<string>",
  "departureDate": "2023-12-25",
  "arrivalDate": "2023-12-25",
  "pickupPoint": "<string>",
  "deliveryPoint": "<string>",
  "pricePerKg": 123,
  "totalAmount": 123,
  "platformCommission": 123,
  "carrierAmount": 123,
  "paymentId": "<string>",
  "authorizationId": "<string>",
  "captureId": "<string>",
  "refundId": "<string>",
  "paymentStatus": "<string>",
  "paymentDate": "2023-11-07T05:31:56Z",
  "paymentApprovalUrl": "<string>",
  "senderName": "<string>",
  "senderEmail": "<string>",
  "carrierName": "<string>",
  "carrierEmail": "<string>",
  "invoiceId": "<string>",
  "invoiceUrl": "<string>",
  "items": [
    {
      "categoryId": 123,
      "code": "<string>",
      "name": "<string>",
      "reservedQuantity": 123,
      "description": "<string>",
      "weight": 123,
      "lengthCm": 123,
      "widthCm": 123,
      "heightCm": 123,
      "isFragile": true,
      "containsLiquids": true,
      "imageUrl": "<string>"
    }
  ],
  "recipient": {
    "firstName": "<string>",
    "lastName": "<string>",
    "email": "<string>",
    "phone": "<string>",
    "address": "<string>",
    "city": "<string>",
    "postalCode": "<string>",
    "instructions": "<string>"
  },
  "reservationDate": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

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

Path Parameters

bookingId
integer<int32>
required

Body

application/json
code
string

Response

Deposit code validated

id
integer<int32>
reservationNumber
string
announcementId
integer<int32>
senderId
integer<int32>
carrierId
integer<int32>
status
string
reservedWeight
number<double>
contentInfo
string
depositCode
string
deliveryCode
string
departureCity
string
arrivalCity
string
departureDate
string<date>
arrivalDate
string<date>
pickupPoint
string
deliveryPoint
string
pricePerKg
number
totalAmount
number
platformCommission
number
carrierAmount
number
paymentId
string
authorizationId
string
captureId
string
refundId
string
paymentStatus
string
paymentDate
string<date-time>
paymentApprovalUrl
string
senderName
string
senderEmail
string
carrierName
string
carrierEmail
string
invoiceId
string
invoiceUrl
string
items
object[]
recipient
object
reservationDate
string<date-time>