Update compartment allocation

PATCH /app/lockers/{externalLockerId}/compartments
App key auth

Update the compartment allocation for a given parcel based on new dimensions. This is useful when reallocating parcels to different compartments.

Path parameters

  • externalLockerId string Required

    The external locker ID

Query parameters

  • parcelId string Required

    Parcel for which the compartment should be changed

application/json

Body Required

  • lockerModuleId string

    Locker module ID

  • depth integer

    Depth in mm

  • height integer

    Height in mm

  • width integer

    Width in mm

  • compartmentName string

    Values are SMALL, MEDIUM, LARGE, XLARGE, or XXLARGE.

Responses

  • 200

    Compartment allocation updated successfully

  • 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

    Locker 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
PATCH /app/lockers/{externalLockerId}/compartments 
curl \
 --request PATCH 'https://api.staging.glsnxt.com/ooh/carrier-connector/v1/app/lockers/{externalLockerId}/compartments?parcelId=string' \
 --header "X-APP-Key: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"lockerModuleId":"module789","depth":140,"height":260,"width":400,"compartmentName":"MEDIUM"}'
Request examples 
{
  "lockerModuleId": "module789",
  "depth": 140,
  "height": 260,
  "width": 400,
  "compartmentName": "MEDIUM"
}
Response examples (401) 
{
  "error": "Unauthorized"
}
Response examples (400) 
{
  "error": "Invalid request. Check parameters and try again."
}
Response examples (500) 
{
  "error": "Internal Server Error"
}