Locker Return
Locker Return is Instabee's main return product, where consumers drop off parcels at a locker for return to the merchant. This product supports four different usage modes:
- Standalone return, with label — A complete return not connected to any outbound parcel. The consumer places a label on the parcel.
- Standalone return, labelless — Same as above, but no label is required. We strongly recommend this option as it provides a much smoother consumer experience.
- Associated return, with label — A return connected to an outbound parcel via
associatedParcelId. The return cannot be initiated until the outbound parcel has been delivered. - Associated return, labelless — Same connected return flow, but without a label.
Important: A parcel size is required when creating a return order. Make sure to discuss with your Implementation Manager how to properly set up this product and what parcel sizes to use.
Feature Comparison
The following tables show what features are unlocked at each integration level. Higher levels provide better return options and consumer experience.
Availability Features
Level 0 No integration | Level 1 Get All Lockers | Level 2 Availability with: | Level 3 Availability with: | Level 4 Availability with: | Level 5 Availability with: | Level 6 Availability with: | |
|---|---|---|---|---|---|---|---|
• Nothing | • Country Code | • Postal Code • Country Code | • Postal Code • Country Code • Email | • Postal Code • Country Code • Email • Recipient Address | • Postal Code • Country Code • Email • Recipient Address • Cart info - Estimated size | • Postal Code • Country Code • Email • Recipient Address • Cart info - Specific size • Alt, Product Sizes | |
Delivery Options | |||||||
Geolocation | |||||||
Advanced Ranking | |||||||
Estimated Time of Arrival* | |||||||
Capacity Managment | |||||||
Parcel Size Optimisation |
* This also required a commitment of packing times and pickup times for all parcels
Post Purchase Call Features
Level 0 Nothing | Level 1 Minimum amount of data | Level 2 Regular amount of data | Level 3 Great amount of data | Level 4 Awesome amount of data | |
|---|---|---|---|---|---|
• Availability Token • Selected Brand • Selected Product • Selected Delivery Option | • Availability Token • Selected Brand • Selected Product • Selected Delivery Option • Recipient Information | • Availability Token • Selected Brand • Selected Product • Selected Delivery Option • Recipient Information • Parcel Dimensions | • Availability Token • Selected Brand • Selected Product • Selected Delivery Option • Recipient Information • Parcel Cart Information • Identification Options • Delivery Instructions | ||
Capacity Management | |||||
Smart Create Order | |||||
Operation Optimisation | |||||
Consumer Communication |
Post Packing Call Features
Level 0 Nothing | Level 1 Minimum amount of data | Level 2 Regular amount of data | Level 3 Great amount of data | Level 4 Awesome amount of data | Level X Order data is sent in Post Purchase | |
|---|---|---|---|---|---|---|
• Nothing | • Availability Token • Selected Brand • Selected Product • Recipient Information • Parcel ID | • Availability Token • Selected Brand • Selected Product • Selected Delivery Option • Recipient Information • Parcel ID | • Availability Token • Selected Brand • Selected Product • Selected Delivery Option • Recipient Information • Parcel Dimensions • Parcel ID | • Availability Token • Selected Brand • Selected Product • Selected Delivery Option • Recipient Information • Parcel Cart Information • Identification Options • Delivery Instructions • Parcel ID | • Parcel Confirmation • Parcel ID | |
Consumer Experience | ||||||
Smooth Delivery |
Product Types
Instabee offers different product types to meet various delivery needs. Each product type has specific characteristics and use cases. Below is a comprehensive list of all available products:
Public Products
LOCKER_EXPRESS
Instabee's main locker delivery product. Use this for real-time checkout locker selection. Fetch availability in real time and present lockers to the consumer. Use product type LOCKER_EXPRESS for both Post Purchase and Post Packing calls.
LOCKER_RETURN
Instabee's main locker return product. Supports four modes: standalone or associated return, with or without a label. Labelless is recommended. For associated returns, use associatedParcelId to link to the outbound parcel — the return will not activate until the outbound parcel is delivered. Parcel size is required.
HOME_DELIVERY
Instabee's main home delivery product. Validate the postal code, then create orders when consumers choose home delivery in checkout. Advanced delivery day selection is available — discuss with your Implementation Manager.
Internal Products
LOCKER_CAPACITY_SURPLUS
White label product routing orders to lockers with surplus capacity. No consumer locker selection or brand visibility. Faster and cheaper than standard allocation. Address required for availability check. Sweden only.
LOCKER_ALLOCATION
White label product using Instabee's broader locker network. No consumer locker selection or brand visibility. Lower SLA guarantee than Capacity Surplus. Address required for availability check. Sweden only.
LOCKER_AREA
Used for the Locker Light product where no specific locker is selected in checkout. The availability response returns a special temporary sortCode that must not be modified or printed on labels. Used for Post Purchase; the real locker is resolved at Post Packing.
Note: Hidden product types are only shown when viewing documentation with the ?showEverything=truequery parameter. .Typical Integration Workflow
- Fetch Lockers — Find available drop-off lockers for the consumer's postal code
- Consumer Selects Locker — The consumer chooses their preferred drop-off locker
- Create Return — Create the return order with the selected locker's sortCode, consumer details, and parcel dimensions
- Consumer Drop-off — The consumer drops the parcel at the locker using the QR code or code provided by Instabee
- Return to Merchant — Instabee picks up the parcel and delivers it back to you
API base URLs
Send production traffic to the production host and sandbox or test traffic to the sandbox host. Paths, headers, and request bodies are the same in both environments; use credentials issued for the environment you call.
| Environment | Base URL |
|---|---|
| Production | https://api.integration.instabee.com/ |
| Sandbox | https://sandbox-api.integration.instabee.com/ |
Supported Countries
Instabee currently operates in the following countries:
- Sweden (SE)
- Norway (NO)
- Denmark (DK)
- Finland (FI)
- Netherlands (NL)
Next Steps
- Fetch Lockers — Find available drop-off lockers
- Create Return — Create the return order
Need help? Our technical support team is available to assist with your integration. Contact us at integration@instabee.com