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

Instabee API

Locker Light

Locker Light is Instabee's new product where the consumer only selects Instabox in checkout, but not an actual locker. The locker selection will be made by Instabee at the time when the order is created — when the order is packed and ready.

An availability call is still required to verify that we deliver to the consumer's postal code. The response will include a special sortCode that does not represent a specific locker. This sortCode must not be changed, validated, or tampered with in any way.

The Post Purchase call works the same as for standard Locker Delivery. For Post Packing, you have two options:

  • Option 1: Create the order using the special sortCode from the availability response and use the label we return.
  • Option 2: Before creating the order, call the Resolve sortCode endpoint. This returns the real sortCode representing the actual locker we will deliver to. Use this on both your label and the Post Packing call.

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/

Next Steps

Command Palette

Search for a command to run...