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 30, 2024

staging
1.0
Compare

API structure has changed

7 structure changes including:
7 Modifications
Modified 7 Breaking
GET /lockers
  • Response
  • 200 response Modified
    • application/json content type Modified
      • carriers property Modified
        • name property Modified
          • Property is now deprecated
        • lockerName property Added
PATCH /lockers/{uid}
  • Body
  • application/json content type Modified
    • carrier property Modified
      • name property Modified
        • Property is now deprecated
      • lockerName property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • carriers property Modified
        • name property Modified
          • Property is now deprecated
        • lockerName property Added
  • Path
  • lockerUid path parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • uid path parameter Added
POST /app/courier/sessions/events
  • Body
  • application/json content type Modified
    • errors property Modified
      • errorLevel, errorCode properties Modified
        • Type went from string to string | null
POST /lockers
  • Body
  • application/json content type Modified
    • carrier property Modified
      • name property Modified
        • Property is now deprecated
      • lockerName property Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • carriers property Modified
        • name property Modified
          • Property is now deprecated
        • lockerName property Added
POST CollectionNotificationwebhook
  • Response
  • 200 response Modified
    • application/json content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • 401 response Modified
    • application/json content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • 500 response Modified
    • application/json content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • 400 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Body
  • application/json content type Added
POST LockerUpdateswebhook
  • Response
  • 200 response Modified
    • application/json content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • 401 response Modified
    • application/json content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • 500 response Modified
    • application/json content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • 400 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Body
  • application/json content type Added
POST ParcelUpdateswebhook
  • Response
  • 200 response Modified
    • application/json content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • 401 response Modified
    • application/json content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • 500 response Modified
    • application/json content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • 400 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Body
  • application/json content type Added