Change Log - Bloq.it Public API

1.65.0

• Added session-id header to the retrieve a rent and retrieve a rent by external ID endpoints
• Removed session-id header from the get free lockers endpoint

1.64.0

• Added bloq_full reason to the cancel dropoff endpoint

1.63.0

• Add workingHours to Create Bloq Location, Update Bloq Locations and Update Bloq Location by External ID endpoints.
• Add postalCode to Update Bloq Location by External ID endpoint.

1.62.0

• Create Bloq Location endpoint now requires name, postalCode and country in addition to the previously required address, latitude, longitude, city and locationType, aligning the public API with the back-office's required fields

1.61.0

• Added externalID to the Retrieve a Bloq endpoints

1.60.0

• Updated open a locker endpoint to allow expired rents

1.59.0

• Added endpoint to release a reserved or pre-advised rent

1.58.0

• Add metadata, firmwareVersion, frontendVersion, customFrontendVersion to Bloq example
• Fix listBloqs example that returned Locker Ids instead of object
• Fix OpenLockersBulk and OpenLockersBulkAccepted examples to return Bloq titles instead of Ids
• Fix /bloqs/{bloqID}/print-label 200 response

1.57.0

• Added rent.drop_off_misalignment event to the webhooks.

1.56.0

• Added layout field to locker object

1.55.0

• Added new endpoint to create authenticated bloq session
• Added new endpoint to finish an active bloq session
• Added session-id header to protected endpoints
• Added Session schema to components

1.54.0

• Added bundleId to the Rent object

1.53.0

• Added bundleId to the Reserve Delivery endpoint

1.52.0

• Added bloq type to bloq listing endpoints

1.51.0

• Added new endpoint to cancel a rent by external ID

1.50.0

• Changed AccessCodePermissions enum on Courier Access Code endpoint

1.49.0

• Added bloqExternalID to the Reserve Delivery endpoint
• Added requiresAccessibility field to the Reserve Delivery endpoint
• Added allocationType field to the Reserve Locker endpoint

1.48.0

• Added endpoint to finish rent by external ID

1.47.0

• Rename ISO2 to alpha2

1.46.0

• Added country to /bloq
• Added country to /bloq-locations

1.45.0

• Add username, password, permissions and hashAlgorithm to the Create or Update Courier Access Code endpoint

1.44.0

• Introduce maximum value for pagination "limit" parameter on GET requests

1.43.0

• Added a new endpoint to retrieve the current BLE token for a specific Bloq.
• Introduce maximum value for pagination "limit" parameter on GET requests

1.42.0

• Add metadata object to Create Delivery Operations

1.41.0

• Added webhook event: bloq.ux.event

1.40.0

• Add expiryDate, deliveryDateLimit, collectTimeLimit to rent public API

1.39.0

• Added parcel measures to Create Delivery Operation to calculate the best door size

1.38.0

• Added List couriers access codes
• Added Create or Update courier access codes

1.37.0

• Deprecated token_signature parameter in favor of tokenSignature
• Adjust response body on the endpoints cancel dropoff, confirm dropoff and change locker by not sending the entire customer object but the customer id
• Fix collect rent and finish rent responses to include the locker object instead of the locker id only
• Fix 202 responses to include body
• Fix reserve endpoint
• Fix number format to int32
• 202 response code on endpoints that communicate with the locker and explanation about the difference between 200 and 202 response code
• Delivery drop off cancel
• Delivery drop off confirmation
• Delivery door change
• BLE token validation
• Search bloq by external ID
• Report locker problem
• Improve webhooks examples

1.36.2

• Add the possibility to create a Rent with pickUpCodes up to 16 characters

1.36.1

• Change return example for Retrieve a Rent response

1.36.0

• Bloq Location with city and postal code
• Added webhook events: bloq.updated, bloq_location.state_update, bloq_location.created, bloq_location.deployed, bloq_location.churned

1.35.0

• Add the possibility to change the state of a bloq location

1.34.0

• Add operationType, prePickUpActions and carrier to the update rent endpoint

1.33.0

• Added webhook event for changes on the locker maintenance cycle
• Add pre pick up actions to the reserveLocker endpoint
• Change how the carrier is passed when creating a delivery on the reserveLocker endpoint

1.32.0

• Added new endpoint to filter rents that reached a specific state within a given time frame

1.31.0

• Update Get Courier Auth Token response format
• Fix typo on Get Courier Auth Token expiration date description
• Allow to pass the carrier ID when creatimg a delivery

1.30.0

• Added webhook events: bloq.print_label_error, bloq.courier_authentication and rbloq.courier_logout
• Update Create Delivery Operation by receiving the operation type field

1.29.0

• Add endpoint to get courier authentication token

1.28.0

• Change list rents and list active rents endpoints - add the filter by external ID

1.27.0

• Added webhook events: bloq.active, bloq.inactive and rent.waiting_offline_dropoff_sync

1.26.0

• Added webhook events: locker.created, locker.open_locker_error, locker.spontaneous_locker_opening, rent.offline_dropoff, bloq.created

1.25.0

• Added webhook events

1.24.0

• Improve docs - better explanation of the Bloq.It system

1.23.0

• Add openOrCollect endpoint

1.22.0

• Add update rent endpoint

1.21.0

• Add webhook event to when a drop off code check is done
• Add webhook event to when there's a pin attempt
• Add rent externalID to the events that are sent through webhooks

1.20.0

• Add 504 Gateway Timeout Error

1.19.0

• Add locker endpoint to change its availability

1.18.0

• Add the possibility to open multiple lockers of one bloq at the same time
• Add the possibility to update bloqs

1.17.0

• Add the possibility to use multiple pick up codes

1.16.0

• Add new section - printer - all endpoints related to the printer
• Add new fields to webhook events - actionInitiatedBy

1.15.0

• Add new endpoint - get amount of labels available (bulk)
• Add new endpoint - get amount of labels available
• Add new endpoint - notify label replacement

1.14.2

• Change references to pin to the new dropOffCode and pickUpCode

1.14.1

• Add message and title to the events that are sent through websockets

1.14.0

• Add address and postal code to the Bloq model

1.13.0

• Add webhook event to when a drop off process is cancelled
• Add the labelContent, labelTemplateID and desiredLockerType to the create delivery endpoint

1.12.0

• Add Bloq Printing Label endpoint
• Add webhook event to when a label is printed from the Bloq

1.11.0

• Changed List Rent and Active Rents
• Deprecate Collect a Return
• Extend Rent Collect Item to be used during the normal flow, in the in progress state
• Add webhook signatures and explanation
• Change Delivery create such that a delivery can be created without a Bloq or a Locker

1.10.0

• Add Retrieve rent with external ID endpoint
• Add List free Lockers for a given Bloq endpoint
• Add Lockers Measures to the Bloq Schema

1.9.0

• Add Returns and its endpoints
• Add Delivery Ready for Pickup, In Transit, Select Locker and Return Delivery endpoints
• Add Bloq list by locker or rent types

1.8.0

• Deprecate "customer.*" Event Types. Use the return of the request instead

1.7.0

• Deliveries now have the option to define different time limits.
• Added deliveryDateLimit
• Added the new endpoint that fetches only the active rents -> rents/active
• Change field states on rents. Now is an array of objects which contains the state and a timestamp

1.6.0

• Added change log reference

1.5.0

• Added field states to the rent responses

1.4.4

• Added examples to query parameters in webhooks and to startDate and endDate all around

1.4.3

• Added Webhook event list endpoint

1.4.2

• Change api base url from api-demo.bloq.it/ to api.bloq.it/

1.4.1

• Added rate limit 100 requests every 60 seconds to documentation
• List of Bloqs now contains array with the locker IDs and bloq details
• Retrieve Bloqs response now fixed to match real response
• In the locker object: lastLockerOpeningTimestamp -> lastDoorOpeningTimestamp

1.4.0

• Deliveries now have the option to pass customer object with customer fields instead of the customerID (Reserve Locker endpoint)
• Deliveries now have the option to reserve only a Bloq, and then choose the locker in the "Make Delivery" endpoint.
• Add warningOptions
• Add Notify Client
• Add externalID -> rent identifier for the partner