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

Oct 17, 2024

staging
1.0
Compare
1.0

API structure has changed

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