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

Changelog

Last update:
Compare
3 structure changes including:
3 Modifications
Modified 3 Breaking
GET /parcels
  • Response
  • 200 response Modified
    • application/json content type Modified
      • signature property Added
POST CollectionNotificationwebhook
  • Body
  • application/json content type Modified
    • signature property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
POST ParcelUpdateswebhook
  • Body
  • application/json content type Modified
    • signature property Added
1 structure change including:
1 Modification
Modified 1
POST CollectionNotificationwebhook
  • Body
  • application/json content type Modified
    • signature property Added
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
1 structure change including:
1 Modification
Modified 1
POST /app/courier/sessions/events
  • Body
  • application/json content type Modified
    • carrier, provider properties Added
2 structure changes including:
2 Modifications
Modified 2
GET /parcels
  • Response
  • 200 response Modified
    • application/json content type Modified
      • allocationType property Added
POST ParcelUpdateswebhook
  • Body
  • application/json content type Modified
    • allocationType property Added
2 structure changes including:
2 Modifications
Modified 2
POST /parcels/data
  • Body
  • application/json content type Modified
    • allocationType property Added
POST /parcels/data/by-tenant-locker-id
  • Body
  • application/json content type Modified
    • allocationType property Added
2 structure changes including:
1 Breaking change
2 Modifications
Modified 2 Breaking
POST /parcels/data
  • Path went from /parcels/data/by-tenant-locker-id to /parcels/data (same operationId)
    Breaking
POST /parcels/data/by-tenant-locker-id
  • Body
  • application/json content type Modified
    • lockerUid property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • carrierLockerId property Added
1 structure change including:
1 Breaking change
1 Modification
Modified 1 Breaking
POST /parcels/data/by-tenant-locker-id
  • Path went from /parcels/data to /parcels/data/by-tenant-locker-id (same operationId)
    Breaking
1 structure change including:
1 Modification
Modified 1
POST CollectionNotificationwebhook
  • Body
  • application/json content type Modified
    • eventTimestamp property Added
1 structure change including:
1 Modification
Modified 1
POST CollectionNotificationwebhook
  • Body
  • application/json content type Modified
    • courierAccessCode property Modified
      • Type went from string to string | null
5 structure changes including:
5 Modifications
Modified 5
GET /lockers
  • Response
  • 200 response Modified
    • application/json content type Modified
      • provider property Modified
        • lockerModelVersion property Removed
GET /lockers/providers
  • Response
  • 200 response Modified
    • application/json content type Modified
      • lockerModelVersion property Removed
PATCH /lockers/{uid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • provider property Modified
        • lockerModelVersion property Removed
POST /lockers
  • Body
  • application/json content type Modified
    • provider property Modified
      • lockerModelVersion property Removed
  • Response
  • 201 response Modified
    • application/json content type Modified
      • provider property Modified
        • lockerModelVersion property Removed
POST LockerUpdateswebhook
  • Body
  • application/json content type Modified
    • provider property Modified
      • lockerModelVersion property Removed
2 structure changes including:
2 Modifications
Modified 2
POST LockerUpdateswebhook
  • Body
  • application/json content type Modified
    • eventTimestamp property Added
POST ParcelUpdateswebhook
  • Body
  • application/json content type Modified
    • eventTimestamp property Added
5 structure changes including:
5 Modifications
Modified 5
GET /lockers
  • Response
  • 200 response Modified
    • application/json content type Modified
      • provider property Modified
        • lockerModelVersion property Modified
          • Property is now deprecated
        • lockerVersion property Added
GET /lockers/providers
  • Response
  • 200 response Modified
    • application/json content type Modified
      • lockerModelVersion property Modified
        • Property is now deprecated
      • lockerVersion property Added
PATCH /lockers/{uid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • provider property Modified
        • lockerModelVersion property Modified
          • Property is now deprecated
        • lockerVersion property Added
POST /lockers
  • Body
  • application/json content type Modified
    • provider property Modified
      • lockerModelVersion property Modified
        • Property is now deprecated
      • lockerVersion property Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • provider property Modified
        • lockerModelVersion property Modified
          • Property is now deprecated
        • lockerVersion property Added
POST LockerUpdateswebhook
  • Body
  • application/json content type Modified
    • provider property Modified
      • lockerModelVersion property Modified
        • Property is now deprecated
      • lockerVersion property Added
2 structure changes including:
2 Modifications
Modified 2
GET /parcels
  • Response
  • 200 response Modified
    • application/json content type Modified
      • accessCodes property Modified
        • consigneeCollection property Modified
          • Property is now deprecated
          • Type went from object | null to string
        • consigneeCollectionCode property Added
POST ParcelUpdateswebhook
  • Body
  • application/json content type Modified
    • accessCodes property Modified
      • consigneeCollection property Modified
        • Property is now deprecated
        • Type went from object | null to string
        • code, validUntil properties Removed
      • consigneeCollectionCode property Added
2 structure changes including:
2 Modifications
Modified 2 Breaking
GET /parcels
  • Response
  • 200 response Modified
    • application/json content type Modified
      • accessCodes property Modified
        • consigneeCollection property Modified
          • Type went from string to object | null
            Breaking
POST ParcelUpdateswebhook
  • Body
  • application/json content type Modified
    • accessCodes property Modified
      • consigneeCollection property Modified
        • Type went from string to object | null
          Breaking
        • code, validUntil properties Added
1 structure change including:
1 Modification
Modified 1 Breaking
PATCH /lockers/{uid}
  • Body
  • application/json content type Modified
    • carrier, location properties Modified
      • Properties are no longer required
    • provider property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
1 structure change including:
1 Modification
Modified 1 Breaking
GET /parcels
  • Response
  • 200 response Modified
    • application/json content type Modified
      • Type went from object to array[object]
        Breaking
      • shipmentUid, lockerUid, carrierParcelId, carrierLockerId, shipmentType, dimensionsStatus, shipmentStatus, accessCodes, consignee, events properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • response.yaml property Added
4 structure changes including:
4 Modifications
Modified 4 Breaking
GET /lockers
  • Response
  • 200 response Modified
    • application/json content type Modified
      • carriers property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • carrier property Added
  • Query
  • carrierId, providerId query parameters Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • providerName query parameter Added
PATCH /lockers/{uid}
  • Body
  • application/json content type Modified
    • carrier property Modified
      • name property Removed
  • Response
  • 200 response Modified
    • application/json content type Modified
      • carriers property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • carrier property Added
POST /lockers
  • Body
  • application/json content type Modified
    • carrier property Modified
      • name property Removed
  • Response
  • 201 response Modified
    • application/json content type Modified
      • carriers property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • carrier property Added
POST LockerUpdateswebhook
  • Body
  • application/json content type Modified
    • carriers property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • carrier property Added
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
1 structure change including:
1 Modification
Modified 1
POST /parcels/data
  • Body
  • application/json content type Modified
    • shipmentType property Added