Skip to content
/Delivery

Ingrid API (1.0.1)

The Ingrid API is organized around REST. Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.You can use the Ingrid API in test mode, which doesn't affect your live data or interact with carrier networks. The API key you use to authenticate the request determines whether the request is live mode or test mode.

Download OpenAPI description
openapi.json
openapi.yaml
Overview
Ingrid Support
support@ingrid.com
License
Apache 2.0
Languages
Servers
Mock server
https://docs.ingrid.com/_mock/ingrid-api/openapi
https://next.ingrid.com/v1

Delivery

Delivery API endpoints

Operations

List service locations

Request

List available locations for a given service code and country with optional postal code. If latitude and longitude are provided, the locations will be sorted by distance from the given coordinates.

The supplied service code must be for a service that is location based, e.g. instabox pickup.

Change.

Bodyapplication/jsonrequired
serviceCodestring
Example: "svc_instabox-locker-se"
countrystring
Example: "SE"
postalCodestring
Example: "11350"
latitudenumber(double)
Example: 59.329323
longitudenumber(double)
Example: 18.06858
limitinteger(int32)
Default 20
curl -i -X POST \
  https://docs.ingrid.com/_mock/ingrid-api/openapi/v1/delivery/locations \
  -H 'Content-Type: application/json' \
  -d '{
    "serviceCode": "svc_instabox-locker-se",
    "country": "SE",
    "postalCode": "11350",
    "latitude": 59.329323,
    "longitude": 18.06858,
    "limit": 20
  }'

Responses

OK

Bodyapplication/json
foostring
Example: "bar"
forServiceCodestring
Example: "svc_instabox-locker-se"
forCountrystring
Example: "SE"
forPostalCodestring
Example: "11350"
forLatitudenumber(double)
Example: 59.329323
forLongitudenumber(double)
Example: 18.06858
locationsArray of objects(ServiceLocation)
Response
application/json
{
  "foo": "bar",
  "forServiceCode": "svc_instabox-locker-se",
  "forCountry": "SE",
  "forPostalCode": "11350",
  "forLatitude": 59.329323,
  "forLongitude": 18.06858,
  "locations": [
    { … }
  ]
}