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 operates home return pickup in a given postal code area. This is the first step — validate before offering the home return option to the consumer. A 200 response means we pick up in that area; a 404 means it is not serviceable.

Endpoint

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

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_RETURN

Response

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

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

Command Palette

Search for a command to run...