Update parcel status

POST /app/lockers/{externalLockerId}/parcels/status
App key auth

Post updates on parcel status regarding delivery, collection, etc. This endpoint allows updating the status of parcels based on various events.

Path parameters

application/json

Body Required

  • parcelId string

    The unique identifier of the parcel

  • status string

    Values are DRIVER_DELIVERED, DRIVER_PICKED_UP, CONSIGNEE_PICKED_UP, CONSIGNEE_DELIVERED, or COMPARTMENT_DEFECTIVE.

  • payload string | null

    Additional payload if any

Responses

  • 200 application/json

    Parcel status updated 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
  • 404

    Parcel not found

  • 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 /app/lockers/{externalLockerId}/parcels/status 
curl \
 --request POST 'https://api.staging.glsnxt.com/ooh/carrier-connector/v1/app/lockers/{externalLockerId}/parcels/status' \
 --header "X-APP-Key: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '[{"parcelId":"parcel123","status":"DRIVER_DELIVERED","payload":"Additional details about the status update"}]'
Request examples 
[
  {
    "parcelId": "parcel123",
    "status": "DRIVER_DELIVERED",
    "payload": "Additional details about the status update"
  }
]
Response examples (200) 
{
  "status": "Parcel status has been updated successfully"
}
Response examples (401) 
{
  "error": "Unauthorized"
}
Response examples (400) 
{
  "error": "Invalid request. Check parameters and try again."
}
Response examples (500) 
{
  "error": "Internal Server Error"
}