Customer API reference
The smart-locker operations of the partner app API that the customer side calls.
38 operations. Each request is listed in the customer API reference.
Every operation below is part of the partner app API. Try it in the partner app REST reference with an access token or an app key.
REST reference · sApp · Specification OpenAPI 3.1
Pickups
Parcels waiting in lockers with their pickup codes: collect and open the door, hand a pickup to another person and take it back.
| Operation | Request | Summary |
|---|---|---|
platformAppPickups |
GET /app/v1/pickups |
List customer locker pickups |
platformAppPickup |
GET /app/v1/pickups/{deliveryId} |
Show a customer locker pickup |
platformAppCollectPickup |
POST /app/v1/pickups/{deliveryId}/collect |
Collect and remotely open a locker pickup |
platformAppHandOverPickup |
POST /app/v1/pickups/{deliveryId}/handoff |
Hand a locker pickup to somebody else |
platformAppTakeBackPickup |
POST /app/v1/pickups/{deliveryId}/handoff/revoke |
Take back a handed-over locker pickup |
Locker locations
The service provider's locker locations, directions to the lockers inside a building, and the person's preferred locations.
| Operation | Request | Summary |
|---|---|---|
platformAppLockerLocations |
GET /app/v1/locker-locations |
List app-enabled SmartLocker locations |
platformAppLockerLocation |
GET /app/v1/locker-locations/{locationId} |
Show a SmartLocker location |
platformAppLockerLocationGuide |
GET /app/v1/locker-locations/{locationId}/guide |
Indoor directions to the lockers of a location |
platformAppLockerLocationGuideFeedback |
POST /app/v1/locker-locations/{locationId}/guide/feedback |
Answer whether the lockers were found |
platformAppUpdateLockerPreference |
PUT /app/v1/locker-locations/{locationId}/preference |
Update a customer SmartLocker preference |
Locker storage
Bags stored in lockers: add one by its code, keep it, change the return time, collect it at another cabinet, or have it delivered or shipped.
| Operation | Request | Summary |
|---|---|---|
platformAppLockerStorageRentals |
GET /app/v1/locker-storage/rentals |
List the renter's stored luggage |
platformAppLockerStorageRental |
GET /app/v1/locker-storage/rentals/{id} |
Show one stored bag |
platformAppLockerStorageClaim |
POST /app/v1/locker-storage/rentals/claim |
Add a stored bag by its code |
platformAppLockerStorageDelivery |
POST /app/v1/locker-storage/rentals/{id}/delivery |
Have the bag delivered to an address |
platformAppLockerStorageKeep |
POST /app/v1/locker-storage/rentals/{id}/keep |
Keep the bag in its compartment |
platformAppLockerStorageOnwardQuote |
POST /app/v1/locker-storage/rentals/{id}/onward-quote |
Price delivery and shipment to an address |
platformAppLockerStoragePickupSite |
POST /app/v1/locker-storage/rentals/{id}/pickup-site |
Collect at another cabinet |
platformAppLockerStoragePickupSiteCancel |
POST /app/v1/locker-storage/rentals/{id}/pickup-site/cancel |
Collect where the bag is after all |
platformAppLockerStorageResendCode |
POST /app/v1/locker-storage/rentals/{id}/resend-code |
Send the pickup code again |
platformAppLockerStorageReturnTime |
POST /app/v1/locker-storage/rentals/{id}/return-time |
Change when you come back |
platformAppLockerStorageShipment |
POST /app/v1/locker-storage/rentals/{id}/shipment |
Ship the bag with a carrier or courier |
Locker shop
Buying from locker cabinets: the catalogue of a location, orders, opening the next door and asking for a refund; for merchant staff, the items in cells and staff codes.
| Operation | Request | Summary |
|---|---|---|
platformAppLockerShopCatalog |
GET /app/v1/locker-locations/{locationId}/shop |
What a location's cabinets have for sale |
platformAppLockerShopItems |
GET /app/v1/locker-shop/items |
Items in cells (merchant staff) |
platformAppLockerShopCreateOrder |
POST /app/v1/locker-shop/orders |
Buy from a cabinet |
platformAppLockerShopOrders |
GET /app/v1/locker-shop/orders |
The caller's shop purchases |
platformAppLockerShopOrder |
GET /app/v1/locker-shop/orders/{id} |
One shop purchase |
platformAppLockerShopOpen |
POST /app/v1/locker-shop/orders/{id}/open |
Open the next door |
platformAppLockerShopIssueAccessCode |
POST /app/v1/locker-shop/access-codes |
Issue a staff code (merchant staff) |
platformAppLockerShopRefundRequest |
POST /app/v1/locker-shop/orders/{id}/refund-request |
Ask for a refund after a door would not open |
Second-hand handover
A seller and a buyer hand an item over through a locker: the terms, opening a handover, sending and revoking the pickup code, calling it off and reporting a problem.
| Operation | Request | Summary |
|---|---|---|
lockerResaleTerms |
GET /app/v1/locker-resale/terms |
Handover terms for the buyer |
lockerResaleDeals |
GET /app/v1/locker-resale/deals |
Handovers this customer is a party to |
createLockerResaleDeal |
POST /app/v1/locker-resale/deals |
Open a handover |
lockerResaleDeal |
GET /app/v1/locker-resale/deals/{id} |
One handover |
releaseLockerResaleCode |
POST /app/v1/locker-resale/deals/{id}/release |
Send the buyer the pickup code |
revokeLockerResaleCode |
POST /app/v1/locker-resale/deals/{id}/revoke-code |
Revoke the pickup code |
abortLockerResaleDeal |
POST /app/v1/locker-resale/deals/{id}/abort |
Call the handover off |
cancelLockerResaleDeal |
POST /app/v1/locker-resale/deals/{id}/cancel |
Cancel before anything is dropped off |
reportLockerResaleDeal |
POST /app/v1/locker-resale/deals/{id}/report |
Report a problem after collecting |