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

Sep 26, 2024

staging
1.0.0
Compare

API structure has changed

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