Skip to main content
POST
/
v1
/
api
/
announcements
Create a new announcement
curl --request POST \
  --url http://localhost:3091/v1/api/announcements \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "departureCity": "<string>",
  "departureDate": "2023-12-25",
  "arrivalCity": "<string>",
  "arrivalDate": "2023-12-25",
  "availableWeight": 123,
  "pricePerKg": 123,
  "bookingDeadline": "2023-12-25",
  "categories": [
    "<string>"
  ],
  "pickupPoint": "<string>",
  "deliveryPoint": "<string>",
  "additionalInfo": "<string>",
  "agencyId": 123
}
'
{
  "id": 123,
  "departureCity": "<string>",
  "departureDate": "2023-12-25",
  "arrivalCity": "<string>",
  "arrivalDate": "2023-12-25",
  "pickupPoint": "<string>",
  "availableWeight": 123,
  "reservedWeight": 123,
  "additionalInfo": "<string>",
  "status": "<string>",
  "bookingDeadline": "2023-12-25",
  "user": {
    "id": 123,
    "pseudo": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "avatarUrl": "<string>",
    "rating": 123,
    "tripCount": 123,
    "isAgency": true
  },
  "deliveryPoint": "<string>",
  "isActive": true,
  "pricePerKg": 123,
  "visibilityStatus": "<string>",
  "visibilityReason": "<string>",
  "lastVisibilityChange": "2023-11-07T05:31:56Z",
  "authorIsMe": true,
  "categories": [
    {
      "code": "<string>",
      "name": "<string>"
    }
  ],
  "agencyId": 123,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

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

Body

application/json
departureCity
string
required
departureDate
string<date>
required
arrivalCity
string
required
arrivalDate
string<date>
required
availableWeight
number<double>
required
pricePerKg
number
required
bookingDeadline
string<date>
required
categories
string[]
required
pickupPoint
string
deliveryPoint
string
additionalInfo
string
agencyId
integer<int64>

Response

Announcement created successfully

id
integer<int32>
departureCity
string
departureDate
string<date>
arrivalCity
string
arrivalDate
string<date>
pickupPoint
string
availableWeight
number<double>
reservedWeight
number<double>
additionalInfo
string
status
string
bookingDeadline
string<date>
user
object
deliveryPoint
string
isActive
boolean
pricePerKg
number
visibilityStatus
string
visibilityReason
string
lastVisibilityChange
string<date-time>
authorIsMe
boolean
categories
object[]
agencyId
integer<int64>
createdAt
string<date-time>
updatedAt
string<date-time>