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

29 days ago

staging
1.0
Compare

API structure has changed

10 structure changes including:
10 Modifications
Modified 10 Breaking
GET /lockers
  • Response
  • 200 response Modified
    • application/json content type Modified
      • carrier property Modified
        • lockerName, lockerId, activationDate properties Modified
          • Properties are now required
            Breaking
      • provider property Modified
        • name, lockerModel, lockerVersion properties Modified
          • Properties are now required
            Breaking
      • location property Modified
        • street, streetNumber, postalCode, city, lon, lat, countryCode properties Modified
          • Properties are now required
            Breaking
      • features property Modified
        • hasScreen, hasPinPad, hasPinBarcodeReader properties Modified
          • Type went from boolean to boolean | null
      • metadata property Modified
        • key, value properties Modified
          • Type went from string to string | null
      • compartmentTypes property Modified
        • Type went from array[object] to array[object] | null
GET /lockers/providers
  • Response
  • 200 response Modified
    • application/json content type Modified
      • name, lockerModel, lockerVersion properties Modified
        • Properties are now required
          Breaking
GET /parcels
  • Response
  • 200 response Modified
    • application/json content type Modified
      • accessCodes property Modified
        • consigneeCollectionCode property Modified
      • consignee property Modified
        • name, email properties Modified
          • Type went from string to string | null
PATCH /lockers/status
  • Response
  • 409 response Added
PATCH /lockers/{uid}
  • Body
  • application/json content type Modified
    • carrier property Modified
      • lockerName, lockerId, activationDate properties Modified
        • Properties are now required
          Breaking
    • location property Modified
      • street, streetNumber, postalCode, city, lon, lat, countryCode properties Modified
        • Properties are now required
          Breaking
    • metadata property Modified
      • key, value properties Modified
        • Type went from string to string | null
    • features property Modified
      • hasScreen, hasPinPad, hasPinBarcodeReader properties Modified
        • Type went from boolean to boolean | null
  • Response
  • 200 response Modified
    • application/json content type Modified
      • carrier property Modified
        • lockerName, lockerId, activationDate properties Modified
          • Properties are now required
            Breaking
      • provider property Modified
        • name, lockerModel, lockerVersion properties Modified
          • Properties are now required
            Breaking
      • location property Modified
        • street, streetNumber, postalCode, city, lon, lat, countryCode properties Modified
          • Properties are now required
            Breaking
      • features property Modified
        • hasScreen, hasPinPad, hasPinBarcodeReader properties Modified
          • Type went from boolean to boolean | null
      • metadata property Modified
        • key, value properties Modified
          • Type went from string to string | null
      • compartmentTypes property Modified
        • Type went from array[object] to array[object] | null
POST /lockers
  • Body
  • application/json content type Modified
    • carrier property Modified
      • lockerName, lockerId, activationDate properties Modified
        • Properties are now required
          Breaking
    • provider property Modified
      • name, lockerModel, lockerVersion properties Modified
        • Properties are now required
          Breaking
    • location property Modified
      • street, streetNumber, postalCode, city, lon, lat, countryCode properties Modified
        • Properties are now required
          Breaking
    • metadata property Modified
      • key, value properties Modified
        • Type went from string to string | null
    • features property Modified
      • hasScreen, hasPinPad, hasPinBarcodeReader properties Modified
        • Type went from boolean to boolean | null
  • Response
  • 201 response Modified
    • application/json content type Modified
      • carrier property Modified
        • lockerName, lockerId, activationDate properties Modified
          • Properties are now required
            Breaking
      • provider property Modified
        • name, lockerModel, lockerVersion properties Modified
          • Properties are now required
            Breaking
      • location property Modified
        • street, streetNumber, postalCode, city, lon, lat, countryCode properties Modified
          • Properties are now required
            Breaking
      • features property Modified
        • hasScreen, hasPinPad, hasPinBarcodeReader properties Modified
          • Type went from boolean to boolean | null
      • metadata property Modified
        • key, value properties Modified
          • Type went from string to string | null
      • compartmentTypes property Modified
        • Type went from array[object] to array[object] | null
POST /parcels/data
  • Body
  • application/json content type Modified
    • consignee property Modified
      • name, email properties Modified
        • Type went from string to string | null
    • dimensions property Modified
      • depth, height, width properties Modified
        • Type went from integer to integer | null
POST /parcels/data/by-tenant-locker-id
  • Body
  • application/json content type Modified
    • consignee property Modified
      • name, email properties Modified
        • Type went from string to string | null
    • dimensions property Modified
      • depth, height, width properties Modified
        • Type went from integer to integer | null
POST LockerUpdateswebhook
  • Body
  • application/json content type Modified
    • carrier property Modified
      • lockerName, lockerId, activationDate properties Modified
        • Properties are now required
          Breaking
    • provider property Modified
      • name, lockerModel, lockerVersion properties Modified
        • Properties are now required
          Breaking
    • location property Modified
      • street, streetNumber, postalCode, city, lon, lat, countryCode properties Modified
        • Properties are now required
          Breaking
    • features property Modified
      • hasScreen, hasPinPad, hasPinBarcodeReader properties Modified
        • Type went from boolean to boolean | null
    • metadata property Modified
      • key, value properties Modified
        • Type went from string to string | null
    • compartmentTypes property Modified
      • Type went from array[object] to array[object] | null
POST ParcelUpdateswebhook
  • Body
  • application/json content type Modified
    • accessCodes property Modified
      • consigneeCollectionCode property Modified
        • validUntil property Modified
          • Property is no longer required
    • consignee property Modified
      • name, email properties Modified
        • Type went from string to string | null