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

Instabee API

Locker Delivery

Locker Delivery is Instabee's main product. Use this when consumers select a locker in checkout — unless you have been told otherwise by your Implementation Manager.

This product is designed for real-time checkout integration. The availability call should be made in real time as the consumer is browsing delivery options. The minimum required is a postal code, but the more information you send — such as the recipient's address, email, and cart details — the better the delivery options will be and the higher the consumer experience. Better options can directly increase your checkout conversion rate.

Keep delivery options up to date. If the consumer stays in checkout without completing their purchase, make sure to refresh the delivery options by re-calling the availability endpoint regularly.

Feature Comparison

The following tables show what features are unlocked at each integration level. Higher levels provide better delivery options, accuracy, 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

Typical Integration Workflow

  1. Fetch Lockers — Call the availability API in real time as the consumer browses checkout
  2. Display Options — Show available lockers with ETAs and directions to the consumer
  3. Consumer Selects Locker — The consumer chooses their preferred locker
  4. Post Purchase — After payment, register the order to reserve delivery capacity
  5. Fulfillment — Pack the order in your warehouse
  6. Post Packing — Confirm the parcel is packed and ready for pickup
  7. Pickup & Delivery — Instabee collects the parcel and delivers it to the consumer's locker

Command Palette

Search for a command to run...