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. A 200 response means we deliver to that area; a 404 means it is not serviceable.

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

A 200 response indicates that home delivery is available for the requested postal code. A 404 response means the postal code is not serviceable.

Status CodeDescription
200Home delivery is available for this postal code
404Postal code is not serviceable

Command Palette

Search for a command to run...