Frequently asked questions

How can I claim reservations on a request?

The API does not support this operation at this time. You have to commit to a request via the UI first.

Why doesn’t a request appear in the list while I can see it in the UI?

The API only shows reservations with commitments. If a reservation has no commitments, it will not show up in the list.

Authentication

To use the API you need to authenticate yourself. You can do this by providing a Bearer token via the HTTP header Authorization. The token has fine-grained access to the API and can be restricted to certain functionality. The token has to be provided by an administrator of INSTORE. If you loose the token, it has to be regenerated.

Usage

The following example demonstrates the intended usage of the API and is meant to help quick start development. It is not meant to be exhaustive, but as a resource to get started.

Add temps to a reservation

After a service provider has committed a number of temps to a reservation, this reservation can get fetched via the API to provide details of the temps.

  1. List reservations to find the one you want to add temps to.

  2. (Optional) Get reservation to see the details of a reservation.

  3. (Optional) Get temps for a reservation to see the temps details already provided.

  4. Set temps for a reservation to add or update temps details for a reservation.

Reservations

List reservations

You can list existing reservations with commitments. Reservations without commitments will not show up in the list.

Request

$ curl 'https://api.instore.itxbusiness.de/promo/reservations' -i -X GET \
    -H 'Authorization: Bearer 1234567890'
GET /promo/reservations HTTP/1.1
Authorization: Bearer 1234567890
Host: api.instore.itxbusiness.de

Response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 215

[ {
  "id" : 327,
  "status" : "OPEN",
  "city" : "Hamburg",
  "store" : "Hamburg I",
  "storeCode" : 1234,
  "date" : "2025-02-26",
  "start" : "09:00",
  "end" : "17:00",
  "temps" : 3,
  "details" : "MISSING"
} ]
Fields
Path Type Description

[]

Array

A list of reservations

[].id

Number

Id of the reservation

[].status

String

Status of the reservation, one of [OPEN, DONE]

[].city

String

City of the associated store

[].store

String

Name of the associated store

[].storeCode

Number

Store code of the associated store

[].date

String

Date of the reservation, pattern yyyy-MM-dd

[].start

String

Start time of the reservation, pattern HH:mm

[].end

String

End time of the reservation, pattern HH:mm

[].temps

Number

Amount of committed temps

[].details

String

Status of the provided details for the committed temps, one of [COMPLETE, MISSING]

Filter by date

You can filter for reservations set to a specific date.

Request

$ curl 'https://api.instore.itxbusiness.de/promo/reservations?date=2025-02-26' -i -X GET \
    -H 'Authorization: Bearer 1234567890'
GET /promo/reservations?date=2025-02-26 HTTP/1.1
Authorization: Bearer 1234567890
Host: api.instore.itxbusiness.de

Query Parameters

Parameter Description

date

Date of the reservation. Pattern yyyy-MM-dd

Response

[ {
  "id" : 327,
  "status" : "OPEN",
  "city" : "Hamburg",
  "store" : "Hamburg I",
  "storeCode" : 1234,
  "date" : "2025-02-26",
  "start" : "09:00",
  "end" : "17:00",
  "temps" : 3,
  "details" : "MISSING"
} ]

Filter by status

By default, only open reservations are fetched. But you can search reservations by their status. See Fields for possible values.

Request

$ curl 'https://api.instore.itxbusiness.de/promo/reservations?status=OPEN,DONE' -i -X GET \
    -H 'Authorization: Bearer 1234567890'
GET /promo/reservations?status=OPEN,DONE HTTP/1.1
Authorization: Bearer 1234567890
Host: api.instore.itxbusiness.de

Query Parameters

Parameter Description

status

Status values for the reservation. Can be a comma-separated list.

Response

[ {
  "id" : 327,
  "status" : "OPEN",
  "city" : "Hamburg",
  "store" : "Hamburg I",
  "storeCode" : 1234,
  "date" : "2025-02-26",
  "start" : "09:00",
  "end" : "17:00",
  "temps" : 3,
  "details" : "MISSING"
}, {
  "id" : 326,
  "status" : "DONE",
  "city" : "Berlin",
  "store" : "Berlin II",
  "storeCode" : 2345,
  "date" : "2025-02-19",
  "start" : "09:00",
  "end" : "14:00",
  "temps" : 1,
  "details" : "COMPLETE"
} ]

Filter by details status

You can filter reservations by their details status. See Fields for possible values.

Request

$ curl 'https://api.instore.itxbusiness.de/promo/reservations?details=MISSING,COMPLETE' -i -X GET \
    -H 'Authorization: Bearer 1234567890'
GET /promo/reservations?details=MISSING,COMPLETE HTTP/1.1
Authorization: Bearer 1234567890
Host: api.instore.itxbusiness.de

Query Parameters

Parameter Description

details

Status values for the details. Can be a comma-separated list.

Response

[ {
  "id" : 327,
  "status" : "OPEN",
  "city" : "Hamburg",
  "store" : "Hamburg I",
  "storeCode" : 1234,
  "date" : "2025-02-26",
  "start" : "09:00",
  "end" : "17:00",
  "temps" : 3,
  "details" : "MISSING"
}, {
  "id" : 326,
  "status" : "OPEN",
  "city" : "Berlin",
  "store" : "Berlin II",
  "storeCode" : 2345,
  "date" : "2025-02-19",
  "start" : "09:00",
  "end" : "14:00",
  "temps" : 1,
  "details" : "COMPLETE"
} ]

Filter by store code

You can filter for reservations at a specific store code.

Request

$ curl 'https://api.instore.itxbusiness.de/promo/reservations?storeCode=1234' -i -X GET \
    -H 'Authorization: Bearer 1234567890'
GET /promo/reservations?storeCode=1234 HTTP/1.1
Authorization: Bearer 1234567890
Host: api.instore.itxbusiness.de

Query Parameters

Parameter Description

storeCode

Store code of the reservations

Response

[ {
  "id" : 327,
  "status" : "OPEN",
  "city" : "Hamburg",
  "store" : "Hamburg I",
  "storeCode" : 1234,
  "date" : "2025-02-26",
  "start" : "09:00",
  "end" : "17:00",
  "temps" : 3,
  "details" : "MISSING"
} ]

Get reservation

You can get details for a single reservation.

Request

$ curl 'https://api.instore.itxbusiness.de/promo/reservations/327' -i -X GET \
    -H 'Authorization: Bearer 1234567890'
GET /promo/reservations/327 HTTP/1.1
Authorization: Bearer 1234567890
Host: api.instore.itxbusiness.de

The request has the following path parameters.

Table 1. /api/public/promo/reservations/{id}
Parameter Description

id

Id of the reservation

Response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 211

{
  "id" : 327,
  "status" : "OPEN",
  "city" : "Hamburg",
  "store" : "Hamburg I",
  "storeCode" : 1234,
  "date" : "2025-02-26",
  "start" : "09:00",
  "end" : "17:00",
  "temps" : 3,
  "details" : "MISSING"
}
Fields
Path Type Description

id

Number

Id of the reservation

status

String

Status of the reservation, one of [OPEN, DONE]

city

String

City of the associated store

store

String

Name of the associated store

storeCode

Number

Store code of the associated store

date

String

Date of the reservation, pattern yyyy-MM-dd

start

String

Start time of the reservation, pattern HH:mm

end

String

End time of the reservation, pattern HH:mm

temps

Number

Amount of committed temps

details

String

Status of the provided details for the committed temps, one of [COMPLETE, MISSING]

Temps

Get temps

You can get temps for a single reservation.

Request

$ curl 'https://api.instore.itxbusiness.de/promo/reservations/327/temps' -i -X GET \
    -H 'Authorization: Bearer 1234567890'
GET /promo/reservations/327/temps HTTP/1.1
Authorization: Bearer 1234567890
Host: api.instore.itxbusiness.de

The request has the following path parameters.

Table 2. /api/public/promo/reservations/{id}/temps
Parameter Description

id

Id of the reservation

Response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 135

[ {
  "employeeId" : "1138",
  "firstname" : "John",
  "surname" : "Doe",
  "dateOfBirth" : "1980-05-04",
  "residence" : "Hamburg"
} ]
Fields
Path Type Description

[]

Array

A list of temps

[].employeeId

String

Internal reference number of the employee

[].firstname

String

Firstname of the employee

[].surname

String

Surname of the employee

[].dateOfBirth

String

Date of birth of the employee, pattern yyyy-MM-dd

[].residence

String

City of residence of the employee

Set temps

You can update temps for a single reservation. The number of temps can not exceed the number of commitments for the reservation.

Request

$ curl 'https://api.instore.itxbusiness.de/promo/reservations/327/temps' -i -X POST \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'Authorization: Bearer 1234567890' \
    -d '[ {
  "employeeId" : "1138",
  "firstname" : "Jon",
  "surname" : "Doe",
  "dateOfBirth" : "1980-05-04",
  "residence" : "Hamburg"
} ]'
POST /promo/reservations/327/temps HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer 1234567890
Content-Length: 134
Host: api.instore.itxbusiness.de

[ {
  "employeeId" : "1138",
  "firstname" : "Jon",
  "surname" : "Doe",
  "dateOfBirth" : "1980-05-04",
  "residence" : "Hamburg"
} ]

The request has the following path parameters.

Table 3. /api/public/promo/reservations/{id}/temps
Parameter Description

id

Id of the reservation
Fields
Path Type Description

[]

Array

A list of temps

[].employeeId

String

Internal reference number of the employee

[].firstname

String

Firstname of the employee

[].surname

String

Surname of the employee

[].dateOfBirth

String

Date of birth of the employee, pattern yyyy-MM-dd

[].residence

String

City of residence of the employee

Response

HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 134

[ {
  "employeeId" : "1138",
  "firstname" : "Jon",
  "surname" : "Doe",
  "dateOfBirth" : "1980-05-04",
  "residence" : "Hamburg"
} ]
Fields
Path Type Description

[]

Array

A list of temps

[].employeeId

String

Internal reference number of the employee

[].firstname

String

Firstname of the employee

[].surname

String

Surname of the employee

[].dateOfBirth

String

Date of birth of the employee, pattern yyyy-MM-dd

[].residence

String

City of residence of the employee