This documentation is in beta, and might contain errors. Contact us at integration@instabee.com with any questions.

Instabee API

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

Create Return Features

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
Sender Information
Availability Token
Selected Brand
Selected Product
Selected Delivery Option
Sender Information
Parcel Dimensions
Availability Token
Selected Brand
Selected Product
Selected Delivery Option
Sender Information
Parcel Cart Information
Capacity Management
Consumer Communication

Typical Integration Workflow

  1. Fetch Lockers — Find available drop-off lockers for the consumer's postal code
  2. Consumer Selects Locker — The consumer chooses their preferred drop-off locker
  3. Create Return — Create the return order with the selected locker's sortCode, consumer details, and parcel dimensions
  4. Consumer Drop-off — The consumer drops the parcel at the locker using the QR code or code provided by Instabee
  5. 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.

EnvironmentBase URL
Productionhttps://api.integration.instabee.com/
Sandboxhttps://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

Need help? Our technical support team is available to assist with your integration. Contact us at integration@instabee.com

Command Palette

Search for a command to run...