Tracker API (1.0.0)

Download OpenAPI specification:

API for tracker system with geospatial capabilities

authentication

Authentication operations

Login with OAuth2

OAuth2 compatible token login, get an access token and refresh token for future requests

Request Body schema: application/x-www-form-urlencoded
required
Grant Type (string) or Grant Type (null) (Grant Type)
username
required
string (Username)
password
required
string <password> (Password)
scope
string (Scope)
Default: ""
Client Id (string) or Client Id (null) (Client Id)
Client Secret (string) or Client Secret (null) <password> (Client Secret)

Responses

Response samples

Content type
application/json
{
  • "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "token_type": "bearer",
  • "user": {
    }
}

Login with JSON

JSON-based login endpoint, get an access token and refresh token for future requests

Request Body schema: application/json
required
email
required
string <email> (Email)

User email address

password
required
string (Password)

User password

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com",
  • "password": "password123"
}

Response samples

Content type
application/json
{
  • "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "token_type": "bearer",
  • "user": {
    }
}

Refresh access token

Get a new access token using a refresh token from request body

Request Body schema: application/json
required
refresh_token
required
string (Refresh Token)

JWT refresh token

Responses

Request samples

Content type
application/json
{
  • "refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}

Response samples

Content type
application/json
{
  • "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "token_type": "bearer"
}

Refresh access token using cookie

Get a new access token using the refresh token cookie

cookie Parameters
Refresh Token (string) or Refresh Token (null) (Refresh Token)

Responses

Response samples

Content type
application/json
{
  • "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "token_type": "bearer"
}

Logout

Clear the refresh token cookie

Responses

Response samples

Content type
application/json
{ }

users

User management operations

Get All Users

Retrieve a list of all users in the system. Only administrators can access this endpoint.

Authorizations:
OAuth2PasswordBearer
query Parameters
skip
integer (Skip)
Default: 0
limit
integer (Limit)
Default: 100

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create User

Create new user.

Authorizations:
OAuth2PasswordBearer
Request Body schema: application/json
required
name
required
string (Name)

User's full name

email
required
string <email> (Email)

User's email address

roles
Array of strings (Roles)
Default: []

List of user roles

Array of Client List (integers) or Client List (null) (Client List)

List of client IDs the user has access to

object (Notification Preferences)
Default: {"email":false,"ui":true}

User's notification preferences

password
required
string (Password)

User's password (will be hashed)

Responses

Request samples

Content type
application/json
{
  • "client_list": [
    ],
  • "email": "jane.smith@example.com",
  • "name": "Jane Smith",
  • "notification_preferences": {
    },
  • "password": "securepassword123",
  • "roles": [
    ]
}

Response samples

Content type
application/json
{
  • "client_list": [
    ],
  • "created_at": "2025-01-01T00:00:00",
  • "email": "john.doe@example.com",
  • "id": 1,
  • "name": "John Doe",
  • "notification_preferences": {
    },
  • "roles": [
    ],
  • "updated_at": "2025-01-02T00:00:00"
}

Read User Me

Get current user.

Authorizations:
OAuth2PasswordBearer

Responses

Response samples

Content type
application/json
{
  • "client_list": [
    ],
  • "created_at": "2025-01-01T00:00:00",
  • "email": "john.doe@example.com",
  • "id": 1,
  • "name": "John Doe",
  • "notification_preferences": {
    },
  • "roles": [
    ],
  • "updated_at": "2025-01-02T00:00:00"
}

Update User Me

Update own user.

Authorizations:
OAuth2PasswordBearer
Request Body schema: application/json
password
string (Password)
name
string (Name)
email
string <email> (Email)

Responses

Request samples

Content type
application/json
{
  • "password": "string",
  • "name": "string",
  • "email": "user@example.com"
}

Response samples

Content type
application/json
{
  • "client_list": [
    ],
  • "created_at": "2025-01-01T00:00:00",
  • "email": "john.doe@example.com",
  • "id": 1,
  • "name": "John Doe",
  • "notification_preferences": {
    },
  • "roles": [
    ],
  • "updated_at": "2025-01-02T00:00:00"
}

Read User By Id

Get a specific user by id.

Only admin users can view other users' profiles. Regular users can only access their own profile via the /me endpoint.

Authorizations:
OAuth2PasswordBearer
path Parameters
user_id
required
integer (User Id)

Responses

Response samples

Content type
application/json
{
  • "client_list": [
    ],
  • "created_at": "2025-01-01T00:00:00",
  • "email": "john.doe@example.com",
  • "id": 1,
  • "name": "John Doe",
  • "notification_preferences": {
    },
  • "roles": [
    ],
  • "updated_at": "2025-01-02T00:00:00"
}

Update User

Update a user.

Authorizations:
OAuth2PasswordBearer
path Parameters
user_id
required
integer (User Id)
Request Body schema: application/json
required
Password (string) or Password (null) (Password)

New password (if being changed)

Name (string) or Name (null) (Name)

Updated name

Email (string) or Email (null) (Email)

Updated email address

Array of Roles (strings) or Roles (null) (Roles)

Updated roles

Array of Client List (integers) or Client List (null) (Client List)

Updated client access list

Notification Preferences (object) or Notification Preferences (null) (Notification Preferences)

Updated notification preferences

Responses

Request samples

Content type
application/json
{
  • "client_list": [
    ],
  • "email": "jane.doe@example.com",
  • "name": "Jane Doe",
  • "notification_preferences": {
    },
  • "password": "newsecurepassword456",
  • "roles": [
    ]
}

Response samples

Content type
application/json
{
  • "client_list": [
    ],
  • "created_at": "2025-01-01T00:00:00",
  • "email": "john.doe@example.com",
  • "id": 1,
  • "name": "John Doe",
  • "notification_preferences": {
    },
  • "roles": [
    ],
  • "updated_at": "2025-01-02T00:00:00"
}

Delete User

Delete a user.

Authorizations:
OAuth2PasswordBearer
path Parameters
user_id
required
integer (User Id)

Responses

Response samples

Content type
application/json
{
  • "client_list": [
    ],
  • "created_at": "2025-01-01T00:00:00",
  • "email": "john.doe@example.com",
  • "id": 1,
  • "name": "John Doe",
  • "notification_preferences": {
    },
  • "roles": [
    ],
  • "updated_at": "2025-01-02T00:00:00"
}

clients

Client management operations

Read Clients

Retrieve clients.

  • skip: Number of records to skip (for pagination)
  • limit: Maximum number of records to return
  • id: Optional filter by client ID
  • ids: Optional comma-separated list of client IDs
Authorizations:
OAuth2PasswordBearer
query Parameters
skip
integer (Skip)
Default: 0
limit
integer (Limit)
Default: 100
Id (integer) or Id (null) (Id)
Ids (string) or Ids (null) (Ids)
Sort Field (string) or Sort Field (null) (Sort Field)
Sort Order (string) or Sort Order (null) (Sort Order)

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "total": 0,
  • "page": 0,
  • "size": 0,
  • "pages": 0
}

Create Client

Create new client.

Authorizations:
OAuth2PasswordBearer
Request Body schema: application/json
required
name
required
string (Name)
Logo (string) or Logo (null) (Logo)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "logo": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "logo": "string",
  • "brand_count": 0
}

Read Client

Get client by ID with performance metrics.

Authorizations:
OAuth2PasswordBearer
path Parameters
client_id
required
integer (Client Id)

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update Client

Update a client.

Authorizations:
OAuth2PasswordBearer
path Parameters
client_id
required
integer (Client Id)
Request Body schema: application/json
required
Name (string) or Name (null) (Name)
Logo (string) or Logo (null) (Logo)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "logo": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "logo": "string",
  • "brand_count": 0
}

Delete Client

Delete a client.

Authorizations:
OAuth2PasswordBearer
path Parameters
client_id
required
integer (Client Id)

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "logo": "string",
  • "brand_count": 0
}

Read Client

Get client by ID with performance metrics.

Authorizations:
OAuth2PasswordBearer
path Parameters
client_id
required
integer (Client Id)

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update Client

Update a client.

Authorizations:
OAuth2PasswordBearer
path Parameters
client_id
required
integer (Client Id)
Request Body schema: application/json
required
Name (string) or Name (null) (Name)
Logo (string) or Logo (null) (Logo)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "logo": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "logo": "string",
  • "brand_count": 0
}

Delete Client

Delete a client.

Authorizations:
OAuth2PasswordBearer
path Parameters
client_id
required
integer (Client Id)

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "logo": "string",
  • "brand_count": 0
}

brands

Brand management operations

Read Brands

Retrieve brands with pagination, filtering, and sorting.

Authorizations:
OAuth2PasswordBearer
query Parameters
skip
integer (Skip)
Default: 0
limit
integer (Limit)
Default: 100
Id (integer) or Id (null) (Id)
Client Id (integer) or Client Id (null) (Client Id)
Sort Field (string) or Sort Field (null) (Sort Field)
Sort Order (string) or Sort Order (null) (Sort Order)

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "total": 0,
  • "page": 0,
  • "size": 0,
  • "pages": 0
}

Create Brand

Create new brand.

Authorizations:
OAuth2PasswordBearer
Request Body schema: application/json
required
name
required
string (Name)
Logo (string) or Logo (null) (Logo)
Client Id (integer) or Client Id (null) (Client Id)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "logo": "string",
  • "client_id": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "logo": "string",
  • "client_id": 0,
  • "production_run_count": 0
}

Read Brands

Retrieve brands with pagination, filtering, and sorting.

Authorizations:
OAuth2PasswordBearer
query Parameters
skip
integer (Skip)
Default: 0
limit
integer (Limit)
Default: 100
Id (integer) or Id (null) (Id)
Client Id (integer) or Client Id (null) (Client Id)
Sort Field (string) or Sort Field (null) (Sort Field)
Sort Order (string) or Sort Order (null) (Sort Order)

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "total": 0,
  • "page": 0,
  • "size": 0,
  • "pages": 0
}

Create Brand

Create new brand.

Authorizations:
OAuth2PasswordBearer
Request Body schema: application/json
required
name
required
string (Name)
Logo (string) or Logo (null) (Logo)
Client Id (integer) or Client Id (null) (Client Id)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "logo": "string",
  • "client_id": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "logo": "string",
  • "client_id": 0,
  • "production_run_count": 0
}

Read Brands By Client

Retrieve brands by client ID.

Authorizations:
OAuth2PasswordBearer
path Parameters
client_id
required
integer (Client Id)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Read Brand

Get brand by ID with production runs.

Authorizations:
OAuth2PasswordBearer
path Parameters
brand_id
required
integer (Brand Id)

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update Brand

Update a brand.

Authorizations:
OAuth2PasswordBearer
path Parameters
brand_id
required
integer (Brand Id)
Request Body schema: application/json
required
Name (string) or Name (null) (Name)
Logo (string) or Logo (null) (Logo)
Client Id (integer) or Client Id (null) (Client Id)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "logo": "string",
  • "client_id": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "logo": "string",
  • "client_id": 0,
  • "production_run_count": 0
}

Delete Brand

Delete a brand.

Authorizations:
OAuth2PasswordBearer
path Parameters
brand_id
required
integer (Brand Id)

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "logo": "string",
  • "client_id": 0,
  • "production_run_count": 0
}

Read Brand

Get brand by ID with production runs.

Authorizations:
OAuth2PasswordBearer
path Parameters
brand_id
required
integer (Brand Id)

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update Brand

Update a brand.

Authorizations:
OAuth2PasswordBearer
path Parameters
brand_id
required
integer (Brand Id)
Request Body schema: application/json
required
Name (string) or Name (null) (Name)
Logo (string) or Logo (null) (Logo)
Client Id (integer) or Client Id (null) (Client Id)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "logo": "string",
  • "client_id": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "logo": "string",
  • "client_id": 0,
  • "production_run_count": 0
}

Delete Brand

Delete a brand.

Authorizations:
OAuth2PasswordBearer
path Parameters
brand_id
required
integer (Brand Id)

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "logo": "string",
  • "client_id": 0,
  • "production_run_count": 0
}

production runs

Production run management operations

Read Production Runs

Retrieve production runs.

Production runs are filtered based on the user's client_list. Admin users can see all production runs.

Authorizations:
OAuth2PasswordBearer
query Parameters
skip
integer (Skip)
Default: 0
limit
integer (Limit)
Default: 100
id
integer (Id)

Filter by production run ID

brand_id
integer (Brand Id)

Filter by brand ID

active_only
boolean (Active Only)
Default: false

Filter only active production runs

sort_field
string (Sort Field)

Field to sort by

sort_order
string (Sort Order)

Sort order (asc or desc)

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "total": 0,
  • "page": 0,
  • "size": 0,
  • "pages": 0
}

Create Production Run

Create new production run.

User must have access to the brand's client to create a production run.

Authorizations:
OAuth2PasswordBearer
query Parameters
production_runs_cache
any (Production Runs Cache)
Request Body schema: application/json
required
start_date
required
string <date-time> (Start Date)
End Date (string) or End Date (null) (End Date)
Brand Id (integer) or Brand Id (null) (Brand Id)
Description (string) or Description (null) (Description)
Removal Date (string) or Removal Date (null) (Removal Date)
Image Url (string) or Image Url (null) (Image Url)

Responses

Request samples

Content type
application/json
{
  • "start_date": "2019-08-24T14:15:22Z",
  • "end_date": "2019-08-24T14:15:22Z",
  • "brand_id": 0,
  • "description": "string",
  • "removal_date": "2019-08-24T14:15:22Z",
  • "image_url": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "start_date": "2019-08-24T14:15:22Z",
  • "end_date": "2019-08-24T14:15:22Z",
  • "brand_id": 0,
  • "description": "string",
  • "removal_date": "2019-08-24T14:15:22Z",
  • "image_url": "string",
  • "tracker_count": 0
}

Read Production Runs

Retrieve production runs.

Production runs are filtered based on the user's client_list. Admin users can see all production runs.

Authorizations:
OAuth2PasswordBearer
query Parameters
skip
integer (Skip)
Default: 0
limit
integer (Limit)
Default: 100
id
integer (Id)

Filter by production run ID

brand_id
integer (Brand Id)

Filter by brand ID

active_only
boolean (Active Only)
Default: false

Filter only active production runs

sort_field
string (Sort Field)

Field to sort by

sort_order
string (Sort Order)

Sort order (asc or desc)

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "total": 0,
  • "page": 0,
  • "size": 0,
  • "pages": 0
}

Create Production Run

Create new production run.

User must have access to the brand's client to create a production run.

Authorizations:
OAuth2PasswordBearer
query Parameters
production_runs_cache
any (Production Runs Cache)
Request Body schema: application/json
required
start_date
required
string <date-time> (Start Date)
End Date (string) or End Date (null) (End Date)
Brand Id (integer) or Brand Id (null) (Brand Id)
Description (string) or Description (null) (Description)
Removal Date (string) or Removal Date (null) (Removal Date)
Image Url (string) or Image Url (null) (Image Url)

Responses

Request samples

Content type
application/json
{
  • "start_date": "2019-08-24T14:15:22Z",
  • "end_date": "2019-08-24T14:15:22Z",
  • "brand_id": 0,
  • "description": "string",
  • "removal_date": "2019-08-24T14:15:22Z",
  • "image_url": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "start_date": "2019-08-24T14:15:22Z",
  • "end_date": "2019-08-24T14:15:22Z",
  • "brand_id": 0,
  • "description": "string",
  • "removal_date": "2019-08-24T14:15:22Z",
  • "image_url": "string",
  • "tracker_count": 0
}

Read Production Run

Get production run by ID.

User must have access to the production run's client to view it. Returns production run details with location information but without trackers. For trackers, use the /production-runs/{production_run_id}/trackers endpoint.

Authorizations:
OAuth2PasswordBearer
path Parameters
production_run_id
required
integer (Production Run Id)

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "start_date": "2019-08-24T14:15:22Z",
  • "end_date": "2019-08-24T14:15:22Z",
  • "brand_id": 0,
  • "description": "string",
  • "removal_date": "2019-08-24T14:15:22Z",
  • "image_url": "string",
  • "tracker_count": 0,
  • "delivery_locations": [
    ],
  • "direct_delivery_locations": [
    ],
  • "storage_locations": [
    ],
  • "direct_storage_locations": [
    ]
}

Update Production Run

Update a production run.

User must have access to the production run's client to update it. If changing the brand, user must also have access to the new brand's client.

Authorizations:
OAuth2PasswordBearer
path Parameters
production_run_id
required
integer (Production Run Id)
Request Body schema: application/json
required
Start Date (string) or Start Date (null) (Start Date)
End Date (string) or End Date (null) (End Date)
Brand Id (integer) or Brand Id (null) (Brand Id)
Description (string) or Description (null) (Description)
Removal Date (string) or Removal Date (null) (Removal Date)
Image Url (string) or Image Url (null) (Image Url)

Responses

Request samples

Content type
application/json
{
  • "start_date": "2019-08-24T14:15:22Z",
  • "end_date": "2019-08-24T14:15:22Z",
  • "brand_id": 0,
  • "description": "string",
  • "removal_date": "2019-08-24T14:15:22Z",
  • "image_url": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "start_date": "2019-08-24T14:15:22Z",
  • "end_date": "2019-08-24T14:15:22Z",
  • "brand_id": 0,
  • "description": "string",
  • "removal_date": "2019-08-24T14:15:22Z",
  • "image_url": "string",
  • "tracker_count": 0
}

Delete Production Run

Delete a production run.

User must have access to the production run's client to delete it.

Authorizations:
OAuth2PasswordBearer
path Parameters
production_run_id
required
integer (Production Run Id)

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "start_date": "2019-08-24T14:15:22Z",
  • "end_date": "2019-08-24T14:15:22Z",
  • "brand_id": 0,
  • "description": "string",
  • "removal_date": "2019-08-24T14:15:22Z",
  • "image_url": "string",
  • "tracker_count": 0
}

Read Production Run

Get production run by ID.

User must have access to the production run's client to view it. Returns production run details with location information but without trackers. For trackers, use the /production-runs/{production_run_id}/trackers endpoint.

Authorizations:
OAuth2PasswordBearer
path Parameters
production_run_id
required
integer (Production Run Id)

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "start_date": "2019-08-24T14:15:22Z",
  • "end_date": "2019-08-24T14:15:22Z",
  • "brand_id": 0,
  • "description": "string",
  • "removal_date": "2019-08-24T14:15:22Z",
  • "image_url": "string",
  • "tracker_count": 0,
  • "delivery_locations": [
    ],
  • "direct_delivery_locations": [
    ],
  • "storage_locations": [
    ],
  • "direct_storage_locations": [
    ]
}

Update Production Run

Update a production run.

User must have access to the production run's client to update it. If changing the brand, user must also have access to the new brand's client.

Authorizations:
OAuth2PasswordBearer
path Parameters
production_run_id
required
integer (Production Run Id)
Request Body schema: application/json
required
Start Date (string) or Start Date (null) (Start Date)
End Date (string) or End Date (null) (End Date)
Brand Id (integer) or Brand Id (null) (Brand Id)
Description (string) or Description (null) (Description)
Removal Date (string) or Removal Date (null) (Removal Date)
Image Url (string) or Image Url (null) (Image Url)

Responses

Request samples

Content type
application/json
{
  • "start_date": "2019-08-24T14:15:22Z",
  • "end_date": "2019-08-24T14:15:22Z",
  • "brand_id": 0,
  • "description": "string",
  • "removal_date": "2019-08-24T14:15:22Z",
  • "image_url": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "start_date": "2019-08-24T14:15:22Z",
  • "end_date": "2019-08-24T14:15:22Z",
  • "brand_id": 0,
  • "description": "string",
  • "removal_date": "2019-08-24T14:15:22Z",
  • "image_url": "string",
  • "tracker_count": 0
}

Delete Production Run

Delete a production run.

User must have access to the production run's client to delete it.

Authorizations:
OAuth2PasswordBearer
path Parameters
production_run_id
required
integer (Production Run Id)

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "start_date": "2019-08-24T14:15:22Z",
  • "end_date": "2019-08-24T14:15:22Z",
  • "brand_id": 0,
  • "description": "string",
  • "removal_date": "2019-08-24T14:15:22Z",
  • "image_url": "string",
  • "tracker_count": 0
}

Read Production Run Trackers

Get trackers for a production run.

User must have access to the production run's client to view its trackers.

Authorizations:
OAuth2PasswordBearer
path Parameters
production_run_id
required
integer (Production Run Id)
query Parameters
skip
integer (Skip)
Default: 0
limit
integer (Limit)
Default: 100

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "total": 0,
  • "page": 0,
  • "size": 0,
  • "pages": 0
}

Read Production Run Trackers

Get trackers for a production run.

User must have access to the production run's client to view its trackers.

Authorizations:
OAuth2PasswordBearer
path Parameters
production_run_id
required
integer (Production Run Id)
query Parameters
skip
integer (Skip)
Default: 0
limit
integer (Limit)
Default: 100

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "total": 0,
  • "page": 0,
  • "size": 0,
  • "pages": 0
}

trackers

Tracker management operations

Read Trackers

Retrieve trackers.

Trackers are filtered based on the user's client_list. Admin users can see all trackers.

Set include_latest_location=true to include the latest location history entry with each tracker. This reduces the need for separate API calls to fetch location data.

Authorizations:
OAuth2PasswordBearer
query Parameters
skip
integer (Skip)
Default: 0
limit
integer (Limit)
Default: 100
Id (integer) or Id (null) (Id)
Production Run Id (integer) or Production Run Id (null) (Production Run Id)
TrackerStatus (string) or Status (null) (Status)
Name (string) or Name (null) (Name)
include_latest_location
boolean (Include Latest Location)
Default: false
Sort Field (string) or Sort Field (null) (Sort Field)
Sort Order (string) or Sort Order (null) (Sort Order)

Responses

Response samples

Content type
application/json
null

Create Tracker

Create new tracker.

User must have access to the production run's client to create a tracker.

Authorizations:
OAuth2PasswordBearer
Request Body schema: application/json
required
name
required
string (Name)
Production Run Id (integer) or Production Run Id (null) (Production Run Id)
TrackerStatus (string) or null
Default: "CREATED"
Current State Start (string) or Current State Start (null) (Current State Start)
Total Transit Time (string) or Total Transit Time (null) (Total Transit Time)
Total Storage Time (string) or Total Storage Time (null) (Total Storage Time)
Mac Address (string) or Mac Address (null) (Mac Address)
Advertisement Key (string) or Advertisement Key (null) (Advertisement Key)
Private Key (string) or Private Key (null) (Private Key)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "production_run_id": 0,
  • "current_status": "CREATED",
  • "current_state_start": "2019-08-24T14:15:22Z",
  • "total_transit_time": "string",
  • "total_storage_time": "string",
  • "mac_address": "string",
  • "advertisement_key": "string",
  • "private_key": "string"
}

Response samples

Content type
application/json
null

Get Tracker Status Counts

Get counts of trackers by status.

Returns a dictionary with status names as keys and counts as values.

Authorizations:
OAuth2PasswordBearer

Responses

Response samples

Content type
application/json
null

Import Trackers Csv

Import trackers from a CSV file.

User must have access to the production run's client to import trackers. The CSV file should contain columns for tracker ID/name, advertisement key, private key, and hashed advertisement key.

Authorizations:
OAuth2PasswordBearer
query Parameters
production_run_id
required
integer (Production Run Id)

Production run ID

Request Body schema: multipart/form-data
required
csv_file
required
string <binary> (Csv File)

Responses

Response samples

Content type
application/json
null

Read Tracker

Get tracker by ID.

User must have access to the tracker's client to view it.

Authorizations:
OAuth2PasswordBearer
path Parameters
tracker_id
required
integer (Tracker Id)

Responses

Response samples

Content type
application/json
null

Update Tracker

Update a tracker.

User must have access to the tracker's client to update it. If changing the production run, user must also have access to the new production run's client.

Authorizations:
OAuth2PasswordBearer
path Parameters
tracker_id
required
integer (Tracker Id)
Request Body schema: application/json
required
Name (string) or Name (null) (Name)
Production Run Id (integer) or Production Run Id (null) (Production Run Id)
TrackerStatus (string) or null
Mac Address (string) or Mac Address (null) (Mac Address)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "production_run_id": 0,
  • "current_status": "CREATED",
  • "mac_address": "string"
}

Response samples

Content type
application/json
null

Delete Tracker

Delete a tracker.

User must have access to the tracker's client to delete it.

Authorizations:
OAuth2PasswordBearer
path Parameters
tracker_id
required
integer (Tracker Id)

Responses

Response samples

Content type
application/json
null

Read Tracker Location History

Get location history for a tracker with pagination.

User must have access to the tracker's client to view its location history.

Authorizations:
OAuth2PasswordBearer
path Parameters
tracker_id
required
integer (Tracker Id)
query Parameters
skip
integer (Skip)
Default: 0
limit
integer (Limit)
Default: 10
Start Date (string) or Start Date (null) (Start Date)
End Date (string) or End Date (null) (End Date)

Responses

Response samples

Content type
application/json
null

Read Tracker Status History

Get status history for a tracker.

User must have access to the tracker's client to view its status history.

Authorizations:
OAuth2PasswordBearer
path Parameters
tracker_id
required
integer (Tracker Id)

Responses

Response samples

Content type
application/json
null

Create Tracker Status

Create a new status entry for a tracker.

User must have access to the tracker's client to update its status.

Authorizations:
OAuth2PasswordBearer
path Parameters
tracker_id
required
integer (Tracker Id)
Request Body schema: application/json
required
timestamp
required
string <date-time> (Timestamp)
status
required
string (TrackerStatus)
Enum: "CREATED" "IN_TRANSIT" "IN_STORAGE" "DELIVERED"
tracker_id
required
integer (Tracker Id)
Storage Location Id (integer) or Storage Location Id (null) (Storage Location Id)
Delivery Location Id (integer) or Delivery Location Id (null) (Delivery Location Id)

Responses

Request samples

Content type
application/json
{
  • "timestamp": "2019-08-24T14:15:22Z",
  • "status": "CREATED",
  • "tracker_id": 0,
  • "storage_location_id": 0,
  • "delivery_location_id": 0
}

Response samples

Content type
application/json
null

locations

Location management operations

Read Delivery Locations

Retrieve delivery locations.

Authorizations:
OAuth2PasswordBearer
query Parameters
skip
integer (Skip)
Default: 0
limit
integer (Limit)
Default: 100
production_run_id
integer (Production Run Id)

Filter by production run ID

search
string (Search)

Search by location name

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "total": 0,
  • "page": 0,
  • "size": 0,
  • "pages": 0
}

Create Delivery Location

Create new delivery location.

Authorizations:
OAuth2PasswordBearer
Request Body schema: application/json
required
name
required
string (Name)
required
object (Coordinates)
Production Run Id (integer) or Production Run Id (null) (Production Run Id)
geofence_size_meters
integer (Geofence Size Meters)
Default: 200

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 200
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 200
}

Get Nearby Trackers For Delivery Location

Get trackers within 10km of a delivery location for the same production run.

Authorizations:
OAuth2PasswordBearer
path Parameters
location_id
required
integer (Location Id)

Responses

Response samples

Content type
application/json
null

Get Nearby Trackers For Delivery Location

Get trackers within 10km of a delivery location for the same production run.

Authorizations:
OAuth2PasswordBearer
path Parameters
location_id
required
integer (Location Id)

Responses

Response samples

Content type
application/json
null

Read Delivery Location

Get delivery location by ID.

Authorizations:
OAuth2PasswordBearer
path Parameters
location_id
required
integer (Location Id)

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 200
}

Update Delivery Location

Update a delivery location.

Authorizations:
OAuth2PasswordBearer
path Parameters
location_id
required
integer (Location Id)
Request Body schema: application/json
required
Name (string) or Name (null) (Name)
Coordinates (object) or null
Production Run Id (integer) or Production Run Id (null) (Production Run Id)
Geofence Size Meters (integer) or Geofence Size Meters (null) (Geofence Size Meters)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 200
}

Delete Delivery Location

Delete a delivery location.

Authorizations:
OAuth2PasswordBearer
path Parameters
location_id
required
integer (Location Id)

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 200
}

Read Delivery Location

Get delivery location by ID.

Authorizations:
OAuth2PasswordBearer
path Parameters
location_id
required
integer (Location Id)

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 200
}

Update Delivery Location

Update a delivery location.

Authorizations:
OAuth2PasswordBearer
path Parameters
location_id
required
integer (Location Id)
Request Body schema: application/json
required
Name (string) or Name (null) (Name)
Coordinates (object) or null
Production Run Id (integer) or Production Run Id (null) (Production Run Id)
Geofence Size Meters (integer) or Geofence Size Meters (null) (Geofence Size Meters)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 200
}

Delete Delivery Location

Delete a delivery location.

Authorizations:
OAuth2PasswordBearer
path Parameters
location_id
required
integer (Location Id)

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 200
}

Read Storage Locations

Retrieve storage locations.

Authorizations:
OAuth2PasswordBearer
query Parameters
skip
integer (Skip)
Default: 0
limit
integer (Limit)
Default: 100
Production Run Id (integer) or Production Run Id (null) (Production Run Id)

Filter by production run ID

Search (string) or Search (null) (Search)

Search by location name

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "total": 0,
  • "page": 0,
  • "size": 0,
  • "pages": 0
}

Create Storage Location

Create new storage location.

Authorizations:
OAuth2PasswordBearer
Request Body schema: application/json
required
name
required
string (Name)
required
object (Coordinates)
Production Run Id (integer) or Production Run Id (null) (Production Run Id)
geofence_size_meters
integer (Geofence Size Meters)
Default: 200

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 200
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 200
}

Get Nearby Trackers For Storage Location

Get trackers within 10km of a storage location for the same production run.

Authorizations:
OAuth2PasswordBearer
path Parameters
location_id
required
integer (Location Id)

Responses

Response samples

Content type
application/json
null

Get Nearby Trackers For Storage Location

Get trackers within 10km of a storage location for the same production run.

Authorizations:
OAuth2PasswordBearer
path Parameters
location_id
required
integer (Location Id)

Responses

Response samples

Content type
application/json
null

Read Storage Location

Get storage location by ID.

Authorizations:
OAuth2PasswordBearer
path Parameters
location_id
required
integer (Location Id)

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 200
}

Update Storage Location

Update a storage location.

Authorizations:
OAuth2PasswordBearer
path Parameters
location_id
required
integer (Location Id)
Request Body schema: application/json
required
Name (string) or Name (null) (Name)
Coordinates (object) or null
Production Run Id (integer) or Production Run Id (null) (Production Run Id)
Geofence Size Meters (integer) or Geofence Size Meters (null) (Geofence Size Meters)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 200
}

Delete Storage Location

Delete a storage location.

Authorizations:
OAuth2PasswordBearer
path Parameters
location_id
required
integer (Location Id)

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 200
}

Read Storage Location

Get storage location by ID.

Authorizations:
OAuth2PasswordBearer
path Parameters
location_id
required
integer (Location Id)

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 200
}

Update Storage Location

Update a storage location.

Authorizations:
OAuth2PasswordBearer
path Parameters
location_id
required
integer (Location Id)
Request Body schema: application/json
required
Name (string) or Name (null) (Name)
Coordinates (object) or null
Production Run Id (integer) or Production Run Id (null) (Production Run Id)
Geofence Size Meters (integer) or Geofence Size Meters (null) (Geofence Size Meters)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 200
}

Delete Storage Location

Delete a storage location.

Authorizations:
OAuth2PasswordBearer
path Parameters
location_id
required
integer (Location Id)

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 200
}

Create Location Report

Create new location report. This endpoint is public and does not require authentication.

Request Body schema: application/json
required
hashed_adv_key
required
string (Hashed Adv Key)
timestamp
required
string <date-time> (Timestamp)
required
object (Coordinates)
Confidence (integer) or Confidence (null) (Confidence)
Horizontal Accuracy (number) or Horizontal Accuracy (null) (Horizontal Accuracy)
Nearest City (string) or Nearest City (null) (Nearest City)

Responses

Request samples

Content type
application/json
{
  • "hashed_adv_key": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "coordinates": {
    },
  • "confidence": 0,
  • "horizontal_accuracy": 0,
  • "nearest_city": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "hashed_adv_key": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "coordinates": {
    },
  • "confidence": 0,
  • "horizontal_accuracy": 0,
  • "nearest_city": "string"
}

Create Location Report

Create new location report. This endpoint is public and does not require authentication.

Request Body schema: application/json
required
hashed_adv_key
required
string (Hashed Adv Key)
timestamp
required
string <date-time> (Timestamp)
required
object (Coordinates)
Confidence (integer) or Confidence (null) (Confidence)
Horizontal Accuracy (number) or Horizontal Accuracy (null) (Horizontal Accuracy)
Nearest City (string) or Nearest City (null) (Nearest City)

Responses

Request samples

Content type
application/json
{
  • "hashed_adv_key": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "coordinates": {
    },
  • "confidence": 0,
  • "horizontal_accuracy": 0,
  • "nearest_city": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "hashed_adv_key": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "coordinates": {
    },
  • "confidence": 0,
  • "horizontal_accuracy": 0,
  • "nearest_city": "string"
}

Read Location Reports

Get location reports by hashed advertisement key.

Authorizations:
OAuth2PasswordBearer
path Parameters
hashed_adv_key
required
string (Hashed Adv Key)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Read Location Reports

Get location reports by hashed advertisement key.

Authorizations:
OAuth2PasswordBearer
path Parameters
hashed_adv_key
required
string (Hashed Adv Key)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Nearby Delivery Locations

Get delivery locations where the point is within each location's geofence.

Authorizations:
OAuth2PasswordBearer
query Parameters
latitude
required
number (Latitude)

Latitude of the point

longitude
required
number (Longitude)

Longitude of the point

distance
integer (Distance)
Default: 1000

Distance in meters

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Nearby Delivery Locations

Get delivery locations where the point is within each location's geofence.

Authorizations:
OAuth2PasswordBearer
query Parameters
latitude
required
number (Latitude)

Latitude of the point

longitude
required
number (Longitude)

Longitude of the point

distance
integer (Distance)
Default: 1000

Distance in meters

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Nearby Storage Locations

Get storage locations within a certain distance of a point.

Authorizations:
OAuth2PasswordBearer
query Parameters
latitude
required
number (Latitude)

Latitude of the point

longitude
required
number (Longitude)

Longitude of the point

distance
integer (Distance)
Default: 1000

Distance in meters

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Nearby Storage Locations

Get storage locations within a certain distance of a point.

Authorizations:
OAuth2PasswordBearer
query Parameters
latitude
required
number (Latitude)

Latitude of the point

longitude
required
number (Longitude)

Longitude of the point

distance
integer (Distance)
Default: 1000

Distance in meters

Responses

Response samples

Content type
application/json
[
  • {
    }
]

location reports

Location report operations

Read Location Reports

Retrieve raw location reports.

This endpoint is restricted to admin users only. Location reports have no client relationship, so they can only be accessed by admins.

Authorizations:
OAuth2PasswordBearer
query Parameters
skip
integer (Skip)
Default: 0
limit
integer (Limit)
Default: 100
Hashed Adv Key (string) or Hashed Adv Key (null) (Hashed Adv Key)

Filter by hashed advertisement key

Responses

Response samples

Content type
application/json
[
  • { }
]

Read Location Reports

Retrieve raw location reports.

This endpoint is restricted to admin users only. Location reports have no client relationship, so they can only be accessed by admins.

Authorizations:
OAuth2PasswordBearer
query Parameters
skip
integer (Skip)
Default: 0
limit
integer (Limit)
Default: 100
Hashed Adv Key (string) or Hashed Adv Key (null) (Hashed Adv Key)

Filter by hashed advertisement key

Responses

Response samples

Content type
application/json
[
  • { }
]

Read Location Report

Get a specific location report by ID.

This endpoint is restricted to admin users only. Location reports have no client relationship, so they can only be accessed by admins.

Authorizations:
OAuth2PasswordBearer
path Parameters
report_id
required
integer (Report Id)

Responses

Response samples

Content type
application/json
{ }

Read Location Report

Get a specific location report by ID.

This endpoint is restricted to admin users only. Location reports have no client relationship, so they can only be accessed by admins.

Authorizations:
OAuth2PasswordBearer
path Parameters
report_id
required
integer (Report Id)

Responses

Response samples

Content type
application/json
{ }

images

Image management operations

Read Images

Retrieve images with pagination.

Authorizations:
OAuth2PasswordBearer
query Parameters
skip
integer (Skip)
Default: 0
limit
integer (Limit)
Default: 100

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "total": 0,
  • "page": 0,
  • "size": 0,
  • "pages": 0
}

Upload Image

Upload a new image.

Authorizations:
OAuth2PasswordBearer
Request Body schema: multipart/form-data
required
file
required
string <binary> (File)

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "url_path": "string",
  • "full_url": "string",
  • "original_filename": "string",
  • "mime_type": "string",
  • "size": 0,
  • "width": 0,
  • "height": 0
}

Read Images

Retrieve images with pagination.

Authorizations:
OAuth2PasswordBearer
query Parameters
skip
integer (Skip)
Default: 0
limit
integer (Limit)
Default: 100

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "total": 0,
  • "page": 0,
  • "size": 0,
  • "pages": 0
}

Upload Image

Upload a new image.

Authorizations:
OAuth2PasswordBearer
Request Body schema: multipart/form-data
required
file
required
string <binary> (File)

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "url_path": "string",
  • "full_url": "string",
  • "original_filename": "string",
  • "mime_type": "string",
  • "size": 0,
  • "width": 0,
  • "height": 0
}

Read Image

Get image by ID.

Authorizations:
OAuth2PasswordBearer
path Parameters
image_id
required
integer (Image Id)

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "original_filename": "string",
  • "mime_type": "string",
  • "size": 0,
  • "width": 0,
  • "height": 0,
  • "url_path": "string",
  • "storage_filename": "string",
  • "uploaded_at": "2019-08-24T14:15:22Z",
  • "full_url": "string"
}

Delete Image

Delete an image.

Authorizations:
OAuth2PasswordBearer
path Parameters
image_id
required
integer (Image Id)

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "original_filename": "string",
  • "mime_type": "string",
  • "size": 0,
  • "width": 0,
  • "height": 0,
  • "url_path": "string",
  • "storage_filename": "string",
  • "uploaded_at": "2019-08-24T14:15:22Z",
  • "full_url": "string"
}

Read Image

Get image by ID.

Authorizations:
OAuth2PasswordBearer
path Parameters
image_id
required
integer (Image Id)

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "original_filename": "string",
  • "mime_type": "string",
  • "size": 0,
  • "width": 0,
  • "height": 0,
  • "url_path": "string",
  • "storage_filename": "string",
  • "uploaded_at": "2019-08-24T14:15:22Z",
  • "full_url": "string"
}

Delete Image

Delete an image.

Authorizations:
OAuth2PasswordBearer
path Parameters
image_id
required
integer (Image Id)

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "original_filename": "string",
  • "mime_type": "string",
  • "size": 0,
  • "width": 0,
  • "height": 0,
  • "url_path": "string",
  • "storage_filename": "string",
  • "uploaded_at": "2019-08-24T14:15:22Z",
  • "full_url": "string"
}

delivery locations

Read Delivery Locations

Retrieve delivery locations.

Authorizations:
OAuth2PasswordBearer
query Parameters
skip
integer (Skip)
Default: 0
limit
integer (Limit)
Default: 100
production_run_id
integer (Production Run Id)

Filter by production run ID

search
string (Search)

Search by location name

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "total": 0,
  • "page": 0,
  • "size": 0,
  • "pages": 0
}

Read Delivery Locations

Retrieve delivery locations.

Authorizations:
OAuth2PasswordBearer
query Parameters
skip
integer (Skip)
Default: 0
limit
integer (Limit)
Default: 100
production_run_id
integer (Production Run Id)

Filter by production run ID

search
string (Search)

Search by location name

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "total": 0,
  • "page": 0,
  • "size": 0,
  • "pages": 0
}

Create Delivery Location

Create new delivery location.

Authorizations:
OAuth2PasswordBearer
Request Body schema: application/json
required
name
required
string (Name)
required
object (Coordinates)
Production Run Id (integer) or Production Run Id (null) (Production Run Id)
geofence_size_meters
integer (Geofence Size Meters)
Default: 200

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 200
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 200
}

Create Delivery Location

Create new delivery location.

Authorizations:
OAuth2PasswordBearer
Request Body schema: application/json
required
name
required
string (Name)
required
object (Coordinates)
Production Run Id (integer) or Production Run Id (null) (Production Run Id)
geofence_size_meters
integer (Geofence Size Meters)
Default: 200

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 200
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 200
}

Get Nearby Trackers For Delivery Location

Get trackers within 10km of a delivery location for the same production run.

Authorizations:
OAuth2PasswordBearer
path Parameters
location_id
required
integer (Location Id)

Responses

Response samples

Content type
application/json
null

Get Nearby Trackers For Delivery Location

Get trackers within 10km of a delivery location for the same production run.

Authorizations:
OAuth2PasswordBearer
path Parameters
location_id
required
integer (Location Id)

Responses

Response samples

Content type
application/json
null

Get Nearby Trackers For Delivery Location

Get trackers within 10km of a delivery location for the same production run.

Authorizations:
OAuth2PasswordBearer
path Parameters
location_id
required
integer (Location Id)

Responses

Response samples

Content type
application/json
null

Get Nearby Trackers For Delivery Location

Get trackers within 10km of a delivery location for the same production run.

Authorizations:
OAuth2PasswordBearer
path Parameters
location_id
required
integer (Location Id)

Responses

Response samples

Content type
application/json
null

Read Delivery Location

Get delivery location by ID.

Authorizations:
OAuth2PasswordBearer
path Parameters
location_id
required
integer (Location Id)

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 200
}

Read Delivery Location

Get delivery location by ID.

Authorizations:
OAuth2PasswordBearer
path Parameters
location_id
required
integer (Location Id)

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 200
}

Update Delivery Location

Update a delivery location.

Authorizations:
OAuth2PasswordBearer
path Parameters
location_id
required
integer (Location Id)
Request Body schema: application/json
required
Name (string) or Name (null) (Name)
Coordinates (object) or null
Production Run Id (integer) or Production Run Id (null) (Production Run Id)
Geofence Size Meters (integer) or Geofence Size Meters (null) (Geofence Size Meters)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 200
}

Update Delivery Location

Update a delivery location.

Authorizations:
OAuth2PasswordBearer
path Parameters
location_id
required
integer (Location Id)
Request Body schema: application/json
required
Name (string) or Name (null) (Name)
Coordinates (object) or null
Production Run Id (integer) or Production Run Id (null) (Production Run Id)
Geofence Size Meters (integer) or Geofence Size Meters (null) (Geofence Size Meters)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 200
}

Delete Delivery Location

Delete a delivery location.

Authorizations:
OAuth2PasswordBearer
path Parameters
location_id
required
integer (Location Id)

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 200
}

Delete Delivery Location

Delete a delivery location.

Authorizations:
OAuth2PasswordBearer
path Parameters
location_id
required
integer (Location Id)

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 200
}

Read Delivery Location

Get delivery location by ID.

Authorizations:
OAuth2PasswordBearer
path Parameters
location_id
required
integer (Location Id)

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 200
}

Read Delivery Location

Get delivery location by ID.

Authorizations:
OAuth2PasswordBearer
path Parameters
location_id
required
integer (Location Id)

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 200
}

Update Delivery Location

Update a delivery location.

Authorizations:
OAuth2PasswordBearer
path Parameters
location_id
required
integer (Location Id)
Request Body schema: application/json
required
Name (string) or Name (null) (Name)
Coordinates (object) or null
Production Run Id (integer) or Production Run Id (null) (Production Run Id)
Geofence Size Meters (integer) or Geofence Size Meters (null) (Geofence Size Meters)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 200
}

Update Delivery Location

Update a delivery location.

Authorizations:
OAuth2PasswordBearer
path Parameters
location_id
required
integer (Location Id)
Request Body schema: application/json
required
Name (string) or Name (null) (Name)
Coordinates (object) or null
Production Run Id (integer) or Production Run Id (null) (Production Run Id)
Geofence Size Meters (integer) or Geofence Size Meters (null) (Geofence Size Meters)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 200
}

Delete Delivery Location

Delete a delivery location.

Authorizations:
OAuth2PasswordBearer
path Parameters
location_id
required
integer (Location Id)

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 200
}

Delete Delivery Location

Delete a delivery location.

Authorizations:
OAuth2PasswordBearer
path Parameters
location_id
required
integer (Location Id)

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 200
}

Read Delivery Locations

Retrieve delivery locations.

Authorizations:
OAuth2PasswordBearer
query Parameters
skip
integer (Skip)
Default: 0
limit
integer (Limit)
Default: 100
production_run_id
integer (Production Run Id)

Filter by production run ID

search
string (Search)

Search by location name

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "total": 0,
  • "page": 0,
  • "size": 0,
  • "pages": 0
}

Read Delivery Locations

Retrieve delivery locations.

Authorizations:
OAuth2PasswordBearer
query Parameters
skip
integer (Skip)
Default: 0
limit
integer (Limit)
Default: 100
production_run_id
integer (Production Run Id)

Filter by production run ID

search
string (Search)

Search by location name

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "total": 0,
  • "page": 0,
  • "size": 0,
  • "pages": 0
}

Create Delivery Location

Create new delivery location.

Authorizations:
OAuth2PasswordBearer
Request Body schema: application/json
required
name
required
string (Name)
required
object (Coordinates)
Production Run Id (integer) or Production Run Id (null) (Production Run Id)
geofence_size_meters
integer (Geofence Size Meters)
Default: 200

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 200
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 200
}

Create Delivery Location

Create new delivery location.

Authorizations:
OAuth2PasswordBearer
Request Body schema: application/json
required
name
required
string (Name)
required
object (Coordinates)
Production Run Id (integer) or Production Run Id (null) (Production Run Id)
geofence_size_meters
integer (Geofence Size Meters)
Default: 200

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 200
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 200
}

Get Nearby Trackers For Delivery Location

Get trackers within 10km of a delivery location for the same production run.

Authorizations:
OAuth2PasswordBearer
path Parameters
location_id
required
integer (Location Id)

Responses

Response samples

Content type
application/json
null

Get Nearby Trackers For Delivery Location

Get trackers within 10km of a delivery location for the same production run.

Authorizations:
OAuth2PasswordBearer
path Parameters
location_id
required
integer (Location Id)

Responses

Response samples

Content type
application/json
null

Get Nearby Trackers For Delivery Location

Get trackers within 10km of a delivery location for the same production run.

Authorizations:
OAuth2PasswordBearer
path Parameters
location_id
required
integer (Location Id)

Responses

Response samples

Content type
application/json
null

Get Nearby Trackers For Delivery Location

Get trackers within 10km of a delivery location for the same production run.

Authorizations:
OAuth2PasswordBearer
path Parameters
location_id
required
integer (Location Id)

Responses

Response samples

Content type
application/json
null

Read Delivery Location

Get delivery location by ID.

Authorizations:
OAuth2PasswordBearer
path Parameters
location_id
required
integer (Location Id)

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 200
}

Read Delivery Location

Get delivery location by ID.

Authorizations:
OAuth2PasswordBearer
path Parameters
location_id
required
integer (Location Id)

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 200
}

Update Delivery Location

Update a delivery location.

Authorizations:
OAuth2PasswordBearer
path Parameters
location_id
required
integer (Location Id)
Request Body schema: application/json
required
Name (string) or Name (null) (Name)
Coordinates (object) or null
Production Run Id (integer) or Production Run Id (null) (Production Run Id)
Geofence Size Meters (integer) or Geofence Size Meters (null) (Geofence Size Meters)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 200
}

Update Delivery Location

Update a delivery location.

Authorizations:
OAuth2PasswordBearer
path Parameters
location_id
required
integer (Location Id)
Request Body schema: application/json
required
Name (string) or Name (null) (Name)
Coordinates (object) or null
Production Run Id (integer) or Production Run Id (null) (Production Run Id)
Geofence Size Meters (integer) or Geofence Size Meters (null) (Geofence Size Meters)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 200
}

Delete Delivery Location

Delete a delivery location.

Authorizations:
OAuth2PasswordBearer
path Parameters
location_id
required
integer (Location Id)

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 200
}

Delete Delivery Location

Delete a delivery location.

Authorizations:
OAuth2PasswordBearer
path Parameters
location_id
required
integer (Location Id)

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 200
}

Read Delivery Location

Get delivery location by ID.

Authorizations:
OAuth2PasswordBearer
path Parameters
location_id
required
integer (Location Id)

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 200
}

Read Delivery Location

Get delivery location by ID.

Authorizations:
OAuth2PasswordBearer
path Parameters
location_id
required
integer (Location Id)

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 200
}

Update Delivery Location

Update a delivery location.

Authorizations:
OAuth2PasswordBearer
path Parameters
location_id
required
integer (Location Id)
Request Body schema: application/json
required
Name (string) or Name (null) (Name)
Coordinates (object) or null
Production Run Id (integer) or Production Run Id (null) (Production Run Id)
Geofence Size Meters (integer) or Geofence Size Meters (null) (Geofence Size Meters)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 200
}

Update Delivery Location

Update a delivery location.

Authorizations:
OAuth2PasswordBearer
path Parameters
location_id
required
integer (Location Id)
Request Body schema: application/json
required
Name (string) or Name (null) (Name)
Coordinates (object) or null
Production Run Id (integer) or Production Run Id (null) (Production Run Id)
Geofence Size Meters (integer) or Geofence Size Meters (null) (Geofence Size Meters)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 200
}

Delete Delivery Location

Delete a delivery location.

Authorizations:
OAuth2PasswordBearer
path Parameters
location_id
required
integer (Location Id)

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 200
}

Delete Delivery Location

Delete a delivery location.

Authorizations:
OAuth2PasswordBearer
path Parameters
location_id
required
integer (Location Id)

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 200
}

storage locations

Read Storage Locations

Retrieve storage locations.

Authorizations:
OAuth2PasswordBearer
query Parameters
skip
integer (Skip)
Default: 0
limit
integer (Limit)
Default: 100
Production Run Id (integer) or Production Run Id (null) (Production Run Id)

Filter by production run ID

Search (string) or Search (null) (Search)

Search by location name

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "total": 0,
  • "page": 0,
  • "size": 0,
  • "pages": 0
}

Read Storage Locations

Retrieve storage locations.

Authorizations:
OAuth2PasswordBearer
query Parameters
skip
integer (Skip)
Default: 0
limit
integer (Limit)
Default: 100
Production Run Id (integer) or Production Run Id (null) (Production Run Id)

Filter by production run ID

Search (string) or Search (null) (Search)

Search by location name

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "total": 0,
  • "page": 0,
  • "size": 0,
  • "pages": 0
}

Create Storage Location

Create new storage location.

Authorizations:
OAuth2PasswordBearer
Request Body schema: application/json
required
name
required
string (Name)
required
object (Coordinates)
Production Run Id (integer) or Production Run Id (null) (Production Run Id)
geofence_size_meters
integer (Geofence Size Meters)
Default: 200

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 200
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 200
}

Create Storage Location

Create new storage location.

Authorizations:
OAuth2PasswordBearer
Request Body schema: application/json
required
name
required
string (Name)
required
object (Coordinates)
Production Run Id (integer) or Production Run Id (null) (Production Run Id)
geofence_size_meters
integer (Geofence Size Meters)
Default: 200

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 200
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 200
}

Get Nearby Trackers For Storage Location

Get trackers within 10km of a storage location for the same production run.

Authorizations:
OAuth2PasswordBearer
path Parameters
location_id
required
integer (Location Id)

Responses

Response samples

Content type
application/json
null

Get Nearby Trackers For Storage Location

Get trackers within 10km of a storage location for the same production run.

Authorizations:
OAuth2PasswordBearer
path Parameters
location_id
required
integer (Location Id)

Responses

Response samples

Content type
application/json
null

Get Nearby Trackers For Storage Location

Get trackers within 10km of a storage location for the same production run.

Authorizations:
OAuth2PasswordBearer
path Parameters
location_id
required
integer (Location Id)

Responses

Response samples

Content type
application/json
null

Get Nearby Trackers For Storage Location

Get trackers within 10km of a storage location for the same production run.

Authorizations:
OAuth2PasswordBearer
path Parameters
location_id
required
integer (Location Id)

Responses

Response samples

Content type
application/json
null

Read Storage Location

Get storage location by ID.

Authorizations:
OAuth2PasswordBearer
path Parameters
location_id
required
integer (Location Id)

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 200
}

Read Storage Location

Get storage location by ID.

Authorizations:
OAuth2PasswordBearer
path Parameters
location_id
required
integer (Location Id)

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 200
}

Update Storage Location

Update a storage location.

Authorizations:
OAuth2PasswordBearer
path Parameters
location_id
required
integer (Location Id)
Request Body schema: application/json
required
Name (string) or Name (null) (Name)
Coordinates (object) or null
Production Run Id (integer) or Production Run Id (null) (Production Run Id)
Geofence Size Meters (integer) or Geofence Size Meters (null) (Geofence Size Meters)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 200
}

Update Storage Location

Update a storage location.

Authorizations:
OAuth2PasswordBearer
path Parameters
location_id
required
integer (Location Id)
Request Body schema: application/json
required
Name (string) or Name (null) (Name)
Coordinates (object) or null
Production Run Id (integer) or Production Run Id (null) (Production Run Id)
Geofence Size Meters (integer) or Geofence Size Meters (null) (Geofence Size Meters)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 200
}

Delete Storage Location

Delete a storage location.

Authorizations:
OAuth2PasswordBearer
path Parameters
location_id
required
integer (Location Id)

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 200
}

Delete Storage Location

Delete a storage location.

Authorizations:
OAuth2PasswordBearer
path Parameters
location_id
required
integer (Location Id)

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 200
}

Read Storage Location

Get storage location by ID.

Authorizations:
OAuth2PasswordBearer
path Parameters
location_id
required
integer (Location Id)

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 200
}

Read Storage Location

Get storage location by ID.

Authorizations:
OAuth2PasswordBearer
path Parameters
location_id
required
integer (Location Id)

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 200
}

Update Storage Location

Update a storage location.

Authorizations:
OAuth2PasswordBearer
path Parameters
location_id
required
integer (Location Id)
Request Body schema: application/json
required
Name (string) or Name (null) (Name)
Coordinates (object) or null
Production Run Id (integer) or Production Run Id (null) (Production Run Id)
Geofence Size Meters (integer) or Geofence Size Meters (null) (Geofence Size Meters)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 200
}

Update Storage Location

Update a storage location.

Authorizations:
OAuth2PasswordBearer
path Parameters
location_id
required
integer (Location Id)
Request Body schema: application/json
required
Name (string) or Name (null) (Name)
Coordinates (object) or null
Production Run Id (integer) or Production Run Id (null) (Production Run Id)
Geofence Size Meters (integer) or Geofence Size Meters (null) (Geofence Size Meters)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 200
}

Delete Storage Location

Delete a storage location.

Authorizations:
OAuth2PasswordBearer
path Parameters
location_id
required
integer (Location Id)

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 200
}

Delete Storage Location

Delete a storage location.

Authorizations:
OAuth2PasswordBearer
path Parameters
location_id
required
integer (Location Id)

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 200
}

Read Storage Locations

Retrieve storage locations.

Authorizations:
OAuth2PasswordBearer
query Parameters
skip
integer (Skip)
Default: 0
limit
integer (Limit)
Default: 100
Production Run Id (integer) or Production Run Id (null) (Production Run Id)

Filter by production run ID

Search (string) or Search (null) (Search)

Search by location name

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "total": 0,
  • "page": 0,
  • "size": 0,
  • "pages": 0
}

Read Storage Locations

Retrieve storage locations.

Authorizations:
OAuth2PasswordBearer
query Parameters
skip
integer (Skip)
Default: 0
limit
integer (Limit)
Default: 100
Production Run Id (integer) or Production Run Id (null) (Production Run Id)

Filter by production run ID

Search (string) or Search (null) (Search)

Search by location name

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "total": 0,
  • "page": 0,
  • "size": 0,
  • "pages": 0
}

Create Storage Location

Create new storage location.

Authorizations:
OAuth2PasswordBearer
Request Body schema: application/json
required
name
required
string (Name)
required
object (Coordinates)
Production Run Id (integer) or Production Run Id (null) (Production Run Id)
geofence_size_meters
integer (Geofence Size Meters)
Default: 200

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 200
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 200
}

Create Storage Location

Create new storage location.

Authorizations:
OAuth2PasswordBearer
Request Body schema: application/json
required
name
required
string (Name)
required
object (Coordinates)
Production Run Id (integer) or Production Run Id (null) (Production Run Id)
geofence_size_meters
integer (Geofence Size Meters)
Default: 200

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 200
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 200
}

Get Nearby Trackers For Storage Location

Get trackers within 10km of a storage location for the same production run.

Authorizations:
OAuth2PasswordBearer
path Parameters
location_id
required
integer (Location Id)

Responses

Response samples

Content type
application/json
null

Get Nearby Trackers For Storage Location

Get trackers within 10km of a storage location for the same production run.

Authorizations:
OAuth2PasswordBearer
path Parameters
location_id
required
integer (Location Id)

Responses

Response samples

Content type
application/json
null

Get Nearby Trackers For Storage Location

Get trackers within 10km of a storage location for the same production run.

Authorizations:
OAuth2PasswordBearer
path Parameters
location_id
required
integer (Location Id)

Responses

Response samples

Content type
application/json
null

Get Nearby Trackers For Storage Location

Get trackers within 10km of a storage location for the same production run.

Authorizations:
OAuth2PasswordBearer
path Parameters
location_id
required
integer (Location Id)

Responses

Response samples

Content type
application/json
null

Read Storage Location

Get storage location by ID.

Authorizations:
OAuth2PasswordBearer
path Parameters
location_id
required
integer (Location Id)

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 200
}

Read Storage Location

Get storage location by ID.

Authorizations:
OAuth2PasswordBearer
path Parameters
location_id
required
integer (Location Id)

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 200
}

Update Storage Location

Update a storage location.

Authorizations:
OAuth2PasswordBearer
path Parameters
location_id
required
integer (Location Id)
Request Body schema: application/json
required
Name (string) or Name (null) (Name)
Coordinates (object) or null
Production Run Id (integer) or Production Run Id (null) (Production Run Id)
Geofence Size Meters (integer) or Geofence Size Meters (null) (Geofence Size Meters)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 200
}

Update Storage Location

Update a storage location.

Authorizations:
OAuth2PasswordBearer
path Parameters
location_id
required
integer (Location Id)
Request Body schema: application/json
required
Name (string) or Name (null) (Name)
Coordinates (object) or null
Production Run Id (integer) or Production Run Id (null) (Production Run Id)
Geofence Size Meters (integer) or Geofence Size Meters (null) (Geofence Size Meters)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 200
}

Delete Storage Location

Delete a storage location.

Authorizations:
OAuth2PasswordBearer
path Parameters
location_id
required
integer (Location Id)

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 200
}

Delete Storage Location

Delete a storage location.

Authorizations:
OAuth2PasswordBearer
path Parameters
location_id
required
integer (Location Id)

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 200
}

Read Storage Location

Get storage location by ID.

Authorizations:
OAuth2PasswordBearer
path Parameters
location_id
required
integer (Location Id)

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 200
}

Read Storage Location

Get storage location by ID.

Authorizations:
OAuth2PasswordBearer
path Parameters
location_id
required
integer (Location Id)

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 200
}

Update Storage Location

Update a storage location.

Authorizations:
OAuth2PasswordBearer
path Parameters
location_id
required
integer (Location Id)
Request Body schema: application/json
required
Name (string) or Name (null) (Name)
Coordinates (object) or null
Production Run Id (integer) or Production Run Id (null) (Production Run Id)
Geofence Size Meters (integer) or Geofence Size Meters (null) (Geofence Size Meters)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 200
}

Update Storage Location

Update a storage location.

Authorizations:
OAuth2PasswordBearer
path Parameters
location_id
required
integer (Location Id)
Request Body schema: application/json
required
Name (string) or Name (null) (Name)
Coordinates (object) or null
Production Run Id (integer) or Production Run Id (null) (Production Run Id)
Geofence Size Meters (integer) or Geofence Size Meters (null) (Geofence Size Meters)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 200
}

Delete Storage Location

Delete a storage location.

Authorizations:
OAuth2PasswordBearer
path Parameters
location_id
required
integer (Location Id)

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 200
}

Delete Storage Location

Delete a storage location.

Authorizations:
OAuth2PasswordBearer
path Parameters
location_id
required
integer (Location Id)

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "coordinates": {
    },
  • "production_run_id": 0,
  • "geofence_size_meters": 200
}

Root

Root endpoint - redirects to API documentation.

Responses

Response samples

Content type
application/json
{
  • "property1": "string",
  • "property2": "string"
}

Health Check

Health check endpoint.

Responses

Response samples

Content type
application/json
{
  • "property1": "string",
  • "property2": "string"
}