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

staging
1.0.0
Compare

API structure has changed

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