Cancel parcel

PATCH /parcels/{parcelId}

Cancel the booking of a specific parcel. Only parcels that haven’t been delivered can be cancelled. This endpoint allows carriers to manage cancellations effectively.

Path parameters

parcelId string Required

The parcel ID to be cancelled

Responses

200

Parcel cancelled successfully
400 application/json

Bad request due to invalid input.
Hide response attributes Show response attributes object
- errorCode string
  
  A code representing the type of error.
- message string
  
  A message describing the error.
401 application/json

The requested resource requires authentication.
Hide response attributes Show response attributes object
- errorCode string
  
  A code representing the type of error.
- message string
  
  A message describing the error.
404 application/json

The requested resource was not found.
Hide response attributes Show response attributes object
- errorCode string
  
  A code representing the type of error.
- message string
  
  A message describing the error.
500 application/json

The server encountered an internal error.
Hide response attributes Show response attributes object
- errorCode string
  
  A code representing the type of error.
- message string
  
  A message describing the error.

PATCH /parcels/{parcelId}

curl \
 --request PATCH 'https://api.staging.glsnxt.com/ooh/carrier-connector/v1/parcels/1234567890' \
 --header "X-API-Key: $API_KEY"

Response examples (400)

{
  "errorCode": "INVALID_REQUEST",
  "message": "Bad request due to invalid input"
}

Response examples (401)

{
  "errorCode": "UNAUTHORIZED",
  "message": "The requested resource requires authentication"
}

Response examples (404)

{
  "errorCode": "NOT_FOUND",
  "message": "The requested resource was not found"
}

Response examples (500)

{
  "errorCode": "SERVER_ERROR",
  "message": "The server encountered an internal error"
}