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

Instabee API

Validate Postal Code

Check whether Instabee offers home delivery to a given postal code. This is the first step in the standard Home Delivery integration — validate the postal code before showing the delivery option in checkout. The endpoint always responds with 201; use showAsOptionInCheckout to decide what to do. true means we deliver to that area; false means it is not serviceable and home delivery should not be shown.

Endpoint

1GET /availability/countries/{countryCode}/postal-codes/{postalCode}/delivery-options?brand={brand}&product=HOME_DELIVERY

Path Parameters

ParameterTypeRequiredDescription
countryCodestringrequiredCountry code (BE, DK, FI, NL, NO, SE)
postalCodestringrequiredPostal code to validate

Query Parameters

ParameterTypeRequiredDescription
brandstringrequiredYour brand identifier (e.g. budbee, porterbuddy)
productstringrequiredMust be HOME_DELIVERY

Response

The endpoint returns 201 whether or not the postal code is serviceable. A postal code we do not deliver to does not return 404. Check showAsOptionInCheckout in the response body instead.

Status CodeshowAsOptionInCheckoutDescription
201trueHome delivery is available for this postal code
201falsePostal code is not serviceable. Do not show home delivery in checkout

Serviceable Postal Code

1{
2  "availabilityToken": "019d8c17-7f32-74bf-8257-bde6184c63db",
3  "deliveryOptions": [],
4  "preselection": "RECOMMENDED",
5  "responseExpiresAt": "2026-04-14T14:04:03.378Z",
6  "showAsOptionInCheckout": true
7}
ParameterTypeDescription
availabilityTokenstringToken to save and use when creating a parcel
deliveryOptionsarrayAlways empty for postal code validation. Use Fetch Delivery Slots if you need delivery windows
preselectionstringRECOMMENDED
responseExpiresAtstringWhen this response expires (ISO-8601 datetime, one hour after the request)
showAsOptionInCheckoutbooleantrue. Show home delivery in checkout

Postal Code Not Serviceable

When we do not deliver to the postal code, the response contains only these three fields. deliveryOptions and responseExpiresAt are not included.

1{
2  "availabilityToken": "019d8c17-8a41-7c2e-9f3b-6e1d2a5b7c90",
3  "preselection": "DISALLOWED",
4  "showAsOptionInCheckout": false
5}
ParameterTypeDescription
availabilityTokenstringToken generated for the request
preselectionstringDISALLOWED. Do not preselect home delivery
showAsOptionInCheckoutbooleanfalse. Do not show home delivery in checkout

Command Palette

Search for a command to run...