Change Updates

Do not miss any Carrier Integration REST API changes, ever again

Subscribe to the Carrier Integration REST API changelog to be up to date on recent changes.

RSS

Aug 12, 2024

staging
1.0.0
Compare

API structure has changed

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