Change Updates

Do not miss any GLS/NXT Hub changes, ever again

Subscribe to the GLS/NXT Hub changelog to be up to date on recent changes.

RSS

Changelog

Last update:
Carrier Integration REST API
4 structure changes including:
4 Modifications
Modified 4
GET /parcels
  • Response
  • 200 response Modified
    • application/json content type Modified
      • carrierLockerId property Modified
        • Type went from string to string | null
      • accessCodes, consignee properties Modified
        • Type went from object to object | null
POST /parcels/data
  • Body
  • application/json content type Modified
    • consignee property Modified
      • Type went from object to object | null
POST CollectionNotificationwebhook
  • Response
  • 200 response Modified
    • application/json content type Modified
      • carrierLockerId property Added
POST ParcelUpdateswebhook
  • Response
  • 200 response Modified
    • application/json content type Modified
      • carrierLockerId property Modified
        • Type went from string to string | null
      • accessCodes, consignee properties Modified
        • Type went from object to object | null
Carrier Integration REST API
1.0
24 structure changes including:
24 Modifications
Modified 24 Breaking
GET /app/courier/lockers/{lockerUid}
  • Authentication
  • App authorization key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • App key auth authentication method Added
GET /app/enduser/parcels/{parcelIds}
  • Authentication
  • App authorization key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • App key auth authentication method Added
GET /app/lockers/{externalLockerId}/compartments
  • Authentication
  • App authorization key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • App key auth authentication method Added
GET /lockers
  • Authentication
  • Api key auth authentication method Added
GET /lockers/providers
  • Authentication
  • Api key auth authentication method Added
GET /parcels
  • Response
  • 200 response Modified
    • application/json content type Modified
      • dimensionsStatus property Added
  • Authentication
  • Api authorization key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Api key auth authentication method Added
PATCH /app/lockers/{externalLockerId}/compartments
  • Authentication
  • App authorization key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • App key auth authentication method Added
PATCH /lockers/status
  • Authentication
  • Api key auth authentication method Added
PATCH /lockers/{uid}
  • Authentication
  • Api key auth authentication method Added
PATCH /parcels/{parcelId}
  • Authentication
  • Api authorization key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Api key auth authentication method Added
POST /app/courier/session
  • Authentication
  • App authorization key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • App key auth authentication method Added
POST /app/courier/sessions/events
  • Authentication
  • App authorization key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • App key auth authentication method Added
POST /app/enduser/session
  • Authentication
  • App authorization key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • App key auth authentication method Added
POST /app/enduser/sessions/events
  • Authentication
  • App authorization key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • App key auth authentication method Added
POST /app/lockers/{externalLockerId}/parcels/status
  • Authentication
  • App authorization key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • App key auth authentication method Added
POST /carrier/alternative-delivery
  • Authentication
  • Api authorization key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Api key auth authentication method Added
POST /carrier/email-notifications
  • Authentication
  • Api authorization key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Api key auth authentication method Added
POST /carrier/parcels/expiry-time
  • Authentication
  • Api authorization key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Api key auth authentication method Added
POST /carrier/redirection
  • Authentication
  • Api authorization key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Api key auth authentication method Added
POST /carrier/sporadic-pick-up
  • Authentication
  • Api authorization key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Api key auth authentication method Added
POST /lockers
  • Authentication
  • Api key auth authentication method Added
POST CollectionNotificationwebhook
  • Authentication
  • Api authorization key, App authorization key, Webhook authorization key authentication methods Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Api key auth, App key auth authentication methods Added
POST LockerUpdateswebhook
  • Authentication
  • Api authorization key, App authorization key, Webhook authorization key authentication methods Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Api key auth, App key auth authentication methods Added
POST ParcelUpdateswebhook
  • Response
  • 200 response Modified
    • application/json content type Modified
      • dimensionsStatus property Added
  • Authentication
  • Api authorization key, App authorization key, Webhook authorization key authentication methods Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Api key auth, App key auth authentication methods Added
Carrier Integration REST API
3 structure changes including:
3 Modifications
Modified 3 Breaking
GET /parcels
  • Response
  • 200 response Modified
    • application/json content type Modified
      • Full types went from array[object] to object
        Breaking
      • shipmentUid, lockerUid, carrierParcelId, carrierLockerId, shipmentType, shipmentStatus, accessCodes, consignee, events properties Added
  • 400 response Modified
    • application/json content type Modified
      • error property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • errorCode, message properties Added
  • 401 response Modified
    • application/json content type Modified
      • error property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • errorCode, message properties Added
  • 404 response Modified
    • application/json content type Added
  • 500 response Modified
    • application/json content type Modified
      • error property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • errorCode, message properties Added
PATCH /parcels/{parcelId}
  • Response
  • 400 response Modified
    • application/json content type Added
  • 401 response Modified
    • application/json content type Modified
      • error property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • errorCode, message properties Added
  • 404 response Modified
    • application/json content type Added
  • 500 response Modified
    • application/json content type Modified
      • error property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • errorCode, message properties Added
POST /parcels/data
  • Response
  • 400 response Modified
    • application/json content type Modified
      • error property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • errorCode, message properties Added
  • 401 response Modified
    • application/json content type Modified
      • error property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • errorCode, message properties Added
  • 500 response Modified
    • application/json content type Modified
      • error property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • errorCode, message properties Added
Carrier Integration REST API
1 structure change including:
1 Addition
Added 1
PATCH /lockers/status
Carrier Integration REST API
1 structure change including:
1 Modification
Modified 1 Breaking
POST /parcels/data
  • Authentication
  • Api authorization key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Api key auth authentication method Added
Carrier Integration REST API
7 structure changes including:
2 Breaking changes
3 Additions
2 Modifications
2 Removals
Modified 2 Breaking
PATCH /lockers/{uid}
  • Path went from /lockers/{lockerId} to /lockers/{uid} (same operationId)
  • Body
  • application/json content type Modified
    • externalLockerId, secondaryExternalLockerId, shipperId, locationCode, region, tour properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • carrier, provider, location, metadata, features properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • location property Modified
        • locationCode property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
      • features property Modified
        • Full types went from object | null to object
          Breaking
        • hasPinPad, hasPinBarcodeReader properties Added
      • compartmentTypes property Modified
        • count property Added
      • id, name, status, carrier, createdAt, updatedAt properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • uid, carriers, provider, metadata properties Added
  • 400 response Modified
    • application/json content type Modified
      • error property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • errorCode, message properties Added
  • 401 response Modified
    • application/json content type Modified
      • error property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • errorCode, message properties Added
  • 404 response Modified
    • application/json content type Added
  • 500 response Modified
    • application/json content type Modified
      • error property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • errorCode, message properties Added
  • Path
  • lockerId path parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • lockerUid path parameter Added
  • Authentication
  • Api authorization key authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST LockerUpdateswebhook
  • Response
  • 200 response Modified
    • application/json content type Modified
      • location property Modified
        • locationCode property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
      • features property Modified
        • Full types went from object | null to object
          Breaking
        • hasPinPad, hasPinBarcodeReader properties Added
      • compartmentTypes property Modified
        • count property Added
      • id, name, status, carrier, createdAt, updatedAt properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • uid, carriers, provider, metadata properties Added
Removed 2 Breaking
GET /lockers
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /lockers
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 3
GET /lockers
GET /lockers/providers
POST /lockers
Carrier Integration REST API
2 structure changes including:
1 Breaking change
1 Addition
1 Removal
Removed 1 Breaking
POST CollectionNotificationwebhook
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 1
POST CollectionNotificationwebhook
Carrier Integration REST API
3 structure changes including:
1 Breaking change
1 Addition
1 Modification
1 Removal
Modified 1 Breaking
GET /app/courier/lockers/{lockerUid}
  • Path went from /app/courier/lockers/{externalLockerId} to /app/courier/lockers/{lockerUid} (same operationId)
  • Path
  • externalLockerId path parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • lockerUid path parameter Added
Removed 1 Breaking
POST /parcels/events
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 1
POST /parcels/data
Carrier Integration REST API
4 structure changes including:
4 Modifications
Modified 4 Breaking
GET /app/lockers/{externalLockerId}/compartments
  • Response
  • 200 response Modified
    • application/json content type Modified
GET /parcels
  • Response
  • 200 response Modified
    • application/json content type Modified
POST /parcels/events
  • Body
  • application/json content type Modified
    • eventType property Modified
      • Property is now required
        Breaking
      • eventType property Modified
        • Property is now required
          Breaking
    • parcelId, externalLockerId, externalLockerName, externalDepotId, externalRegion, deliveryEmail, deliveryName, volume properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • lockerUid, carrierParcelId, consignee, dimensions properties Added
POST ParcelUpdateswebhook
  • Response
  • 200 response Modified
    • application/json content type Modified
      • parcelId, externalLockerId, allocationType, event properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • shipmentUid, lockerUid, carrierParcelId, carrierLockerId, shipmentStatus, accessCodes, consignee, events properties Added
Carrier Integration REST API
1 structure change including:
1 Modification
Modified 1
POST /parcels/events
  • Body
  • application/json content type Modified
    • externalLockerName property Modified
      • Property is no longer required
      • externalLockerName property Modified
        • Property is no longer required
    • externalDepotId property Modified
      • Property is no longer required
      • externalDepotId property Modified
        • Property is no longer required
    • externalRegion property Modified
      • Property is no longer required
      • externalRegion property Modified
        • Property is no longer required
    • volume property Modified
      • Property is no longer required
      • volume property Modified
        • Property is no longer required
    • weight property Modified
      • Property is no longer required
      • weight property Modified
        • Property is no longer required
Carrier Integration REST API