Homerr API Documentation

OVERVIEW

Welcome to Homerr!

The Homerr API allows developers to integrate Homerr services to offer their customers in their online store, application, or e-commerce platform.

WHO IS THIS API FOR

This API is mainly for online retailers who would like to offer Homerr service to their customers. Use our powerful and easy to use RESTful APIs to integrate your e-commerce store’s checkout process with Homerr.

Generate Token for Third Party Integration

This part of the API documentation has been omitted for privacy reasons

Search for Homers by Address

URL:

POST api/2.0/search_homers_by_address

Headers:

Content-Type:application/json

Body

{
  "token":"",
  "street":"Van Diementstraat",
  "zipCode":"1013 CR",
  "city":"Amsterdam",
  "houseNo":"306",
  "package_size": 0,
  "date_from":"2015-08-12 00:00:00",
  "date_to":"2025-08-12 00:00:00",
  "order_type": "PICKUP",
  "max_results":""
}

Response On Success

Array of available homers
If token not present:

{
  "error_code": "TOKEN_NOT_PRESENT",
  "message": "Token not present",
  "success": false
}

Response On Error

If token invalid:

{
  "error_code": "INVALID_TOKEN",
  "message": "Token is not valid",
  "success": false
}
If token invalid:

{
  "error_code": "INVALID_TOKEN",
  "message": "Token is not valid",
  "success": false
}

Make a Pickup Order for Third Party Integration

URL:

POST api/2.0/third_party_integration

Headers:

Content-Type:application/json

Body

{
  "email":"testuser12@homerr.com",
  "token":"",
  "homer_id":number,
  "name":"3rd party user",
  "address":"",
  "zip_code":"",
  "phone_number":"",
  "place":""
}

Required parameters:

email, token, homer_id.

If newly created user needs to log in via mobile app, then address, valid zip code and place is required.

Response On Success

{
  "USER_CREATED": true,
  "PICKUP_CREATED": true,
  "success": true
}
If user with the provided email already exists:

{
  "USER_CREATED": false,
  "PICKUP_CREATED": true,
  "success": true
}

Response On Error

If token not present:

{
  "error_code": "TOKEN_NOT_PRESENT",
  "message": "Token not present",
  "success": false
}
If token invalid:

{
  "error_code": "INVALID_TOKEN",
  "message": "Token is not valid",
  "success": false
}