Set parcel expiry times

POST /carrier/parcels/expiry-time

Set parcel expiry times for reservation, courier delivery, and end-user expiry. This endpoint allows carriers to configure the expiry times for various parcel statuses.

application/json

Body Required

Responses

  • 200 application/json

    Parcel expiry times set successfully

    Hide response attribute Show response attribute object
  • 401 application/json

    Unauthorized. The request is missing valid authentication credentials.

    Hide response attribute Show response attribute object
    • error string

      Error message indicating lack of authorization

  • 400 application/json

    Bad Request. The request is malformed or missing required parameters.

    Hide response attribute Show response attribute object
    • error string

      Error message detailing the cause of the bad request

  • 500 application/json

    Internal Server Error. An unexpected error occurred on the server.

    Hide response attribute Show response attribute object
    • error string

      Error message indicating an internal server error

POST /carrier/parcels/expiry-time
curl \
 --request POST 'https://api.staging.glsnxt.com/ooh/carrier-connector/v1/carrier/parcels/expiry-time' \
 --header "X-API-Key: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"reservationExpiry":"2025-08-20T00:00:00Z","courierDeliveryExpiry":"2025-08-20T00:00:00Z","endUserDeliveryExpiry":"2025-08-20T00:00:00Z"}'
Request examples
{
  "reservationExpiry": "2025-08-20T00:00:00Z",
  "courierDeliveryExpiry": "2025-08-20T00:00:00Z",
  "endUserDeliveryExpiry": "2025-08-20T00:00:00Z"
}
Response examples (200)
{
  "status": "Parcel expiry times have been set successfully"
}
Response examples (401)
{
  "error": "Unauthorized"
}
Response examples (400)
{
  "error": "Invalid request. Check parameters and try again."
}
Response examples (500)
{
  "error": "Internal Server Error"
}