ISOlocity API (2.6.0)

Download OpenAPI specification:Download

The ISOlocity API can be used to create, update and query select data within the ISOlocity platform.

Authentication

bearerAuth

Security Scheme Type	HTTP
HTTP Authorization Scheme	bearer

System Status

Check the current system status

Authorizations:

bearerAuth

Responses

Response samples

200

Content type

application/json

{"status": "success",
"version": "2.0.0",
"online": true
}

Companies

List existing companies in the authorized user's organization

Authorizations:

bearerAuth

query Parameters

page	integer Example: page=1 The current page of data
per_page	integer Example: per_page=50 The desired number of records per page

Responses

Response samples

200

Content type

application/json

{"status": "success",
"message": "The request was successful",
"meta": {"current_page": 1,
"from": 1,
"to": 50,
"total": 100,
"per_page": 50
},
"data": [{"id": 1,
"name": "Test Company",
"is_active": 1,
"created_at": "2020-01-01 12:00:00",
"updated_at": "2020-01-01 12:00:00"
}
]
}

Suppliers

List existing suppliers in the authorized user's organization

Authorizations:

bearerAuth

query Parameters

page	integer Example: page=1 The current page of data
per_page	integer Example: per_page=50 The desired number of records per page

Responses

Response samples

200

Content type

application/json

{"status": "success",
"message": "The request was successful",
"meta": {"current_page": 1,
"from": 1,
"to": 50,
"total": 100,
"per_page": 50
},
"data": [{"id": 123,
"name": "ABC Manufacturing Inc.",
"primary_email": "johnsmith@abc.com",
"primary_name": "John Smith",
"primary_phone": "1-649-123-4567",
"primary_position": "Project Manager",
"secondary_email": "janesmith@abc.com",
"secondary_name": "Jane Smith",
"secondary_phone": "1-649-123-4567",
"secondary_position": "Project Lead",
"created_at": "2020-01-01 12:00:00",
"updated_at": "2020-01-01 12:00:00"
}
]
}

Create a new supplier

Authorizations:

bearerAuth

Request Body schema: application/json

name	string
primary_name	string
primary_email	string
primary_phone	string
primary_position	string
secondary_name	string
secondary_email	string
secondary_phone	string
secondary_position	string
notes	string

Responses

Request samples

Payload

Content type

application/json

{"name": "ABC Manufacturing Inc.",
"primary_name": "John Smith",
"primary_email": "johnsmith@abc.com",
"primary_phone": "1-649-123-4567",
"primary_position": "Project Manager",
"secondary_name": "Jane Smith",
"secondary_email": "janesmith@abc.com",
"secondary_phone": "1-649-123-4567",
"secondary_position": "Project Lead",
"notes": "These are some sample notes for the supplier"
}

Response samples

201

Content type

application/json

{"status": "success",
"message": "The request was successful",
"data": {"id": 123,
"name": "ABC Manufacturing Inc.",
"primary_email": "johnsmith@abc.com",
"primary_name": "John Smith",
"primary_phone": "1-649-123-4567",
"primary_position": "Project Manager",
"secondary_email": "janesmith@abc.com",
"secondary_name": "Jane Smith",
"secondary_phone": "1-649-123-4567",
"secondary_position": "Project Lead",
"created_at": "2020-01-01 12:00:00",
"updated_at": "2020-01-01 12:00:00"
}
}

View information for a particular supplier

Authorizations:

bearerAuth

path Parameters

id

required

integer

The ID of the supplier to retrieve

Responses

Response samples

200
404

Content type

application/json

{"status": "success",
"message": "The request was successful",
"data": {"id": 123,
"name": "ABC Manufacturing Inc.",
"primary_email": "johnsmith@abc.com",
"primary_name": "John Smith",
"primary_phone": "1-649-123-4567",
"primary_position": "Project Manager",
"secondary_email": "janesmith@abc.com",
"secondary_name": "Jane Smith",
"secondary_phone": "1-649-123-4567",
"secondary_position": "Project Lead",
"created_at": "2020-01-01 12:00:00",
"updated_at": "2020-01-01 12:00:00"
}
}

Update an existing supplier

Authorizations:

bearerAuth

path Parameters

id

required

integer

The ID of the supplier to update

Request Body schema: application/json

name	string
primary_name	string
primary_email	string
primary_phone	string
primary_position	string
secondary_name	string
secondary_email	string
secondary_phone	string
secondary_position	string
notes	string

Responses

Request samples

Payload

Content type

application/json

{"name": "ABC Manufacturing Inc.",
"primary_name": "John Smith",
"primary_email": "johnsmith@abc.com",
"primary_phone": "1-649-123-4567",
"primary_position": "Project Manager",
"secondary_name": "Jane Smith",
"secondary_email": "janesmith@abc.com",
"secondary_phone": "1-649-123-4567",
"secondary_position": "Project Lead",
"notes": "These are some sample notes for the supplier"
}

Response samples

200
404

Content type

application/json

{"status": "success",
"message": "The request was successful",
"data": {"id": 123,
"name": "ABC Manufacturing Inc.",
"primary_email": "johnsmith@abc.com",
"primary_name": "John Smith",
"primary_phone": "1-649-123-4567",
"primary_position": "Project Manager",
"secondary_email": "janesmith@abc.com",
"secondary_name": "Jane Smith",
"secondary_phone": "1-649-123-4567",
"secondary_position": "Project Lead",
"created_at": "2020-01-01 12:00:00",
"updated_at": "2020-01-01 12:00:00"
}
}

Inventory

View information for existing inventory

Authorizations:

bearerAuth

query Parameters

page	integer Example: page=1 The current page of data
per_page	integer Example: per_page=50 The desired number of records per page
part_id	any Examples: part_id=13242 - Optional: Search by part id (If this is active, you cannot search by name)
keyword	any Examples: keyword=partName - Optional: Search by keyword (Default null)

Responses

Response samples

200

Content type

application/json

{"status": "success",
"message": "The request was successful",
"data": [{"id": 26137,
"company_id": 1,
"part_id": 10597,
"name": "RAWINGREDIENT",
"identification": "RAWINGREDIENT",
"inventory_name": "RAWINGREDIENT - RAWINGREDIENT",
"quantity": 5,
"unit_of_measure": "string",
"cost": 8,
"value_on_hand": 40,
"is_finished_product": true,
"reorder_point": "0.00000000",
"is_expiry_soon": ""
}
],
"links": {"first": "http://127.0.0.1:8000/2.0/inventory?page=1",
"last": "http://127.0.0.1:8000/2.0/inventory?page=5",
"prev": "http://127.0.0.1:8000/2.0/inventory?page=1",
"next": "http://127.0.0.1:8000/2.0/inventory?page=3"
},
"meta": {"current_page": 2,
"from": 101,
"last_page": 5,
"path": "http://127.0.0.1:8000/2.0/inventory",
"per_page": "100",
"to": 200,
"total": 493
}
}

View information for a particular inventory

Authorizations:

bearerAuth

path Parameters

id

required

integer

The ID of the inventory to retrieve

Responses

Response samples

200

Content type

application/json

{"status": "success",
"message": "The request was successful",
"data": {"id": 26137,
"company_id": 1,
"part_id": 10597,
"batch_number": "Retention Samples",
"quantity": 0,
"is_locked": true,
"is_legacy": false,
"location": "string",
"created_at": "2022-01-12 10:53:18",
"updated_at": "2022-01-12 10:53:18",
"value_on_hand": 0,
"location_list": "string",
"cost": 8,
"location_id": "string",
"legacy_record_id": 5627,
"related_batch_numbers": ["Retention Samples",
"test123",
null
],
"nearest_expiry_date": "string",
"part": { }
}
}

Update the linked locations for a specific inventory

Authorizations:

bearerAuth

path Parameters

id

required

integer

The inventory id to get linked to locations

Request Body schema: application/json

Schema not provided

Responses

Response samples

200

Content type

application/json

{"status": "success",
"message": "The request was successful",
"data": {"id": 26137,
"company_id": 1,
"part_id": 10597,
"batch_number": "Retention Samples",
"quantity": 0,
"is_locked": true,
"is_legacy": false,
"location": "string",
"created_at": "2022-01-12 10:53:18",
"updated_at": "2022-01-12 10:53:18",
"value_on_hand": 0,
"location_list": "string",
"cost": 8,
"location_id": "string",
"legacy_record_id": 5627,
"related_batch_numbers": ["Retention Samples",
"test123",
null
],
"locations": [{"id": 26137,
"name": "Location 1",
"is_active": 1
}
],
"nearest_expiry_date": "string",
"part": { }
}
}

NCRs

Retrieve a list of NCRs

Authorizations:

bearerAuth

query Parameters

page	integer Example: page=1 The current page of data
keyword	string Example: keyword=lot number A keyword to search for in the NCRs
status	string Example: status=Open The status of the NCRs to filter by
source	string Example: source=Internal The source of the NCRs to filter by

Responses

Response samples

200

Content type

application/json

{"status": "success",
"message": "The request was successful",
"data": [{"ncr_number": "jan_16_2023_2",
"source": "internal",
"lot_number": "lot_12345",
"quantity": 10,
"description": "Test description",
"immediate_action": "Test immediate action",
"is_root_cause_determined": false,
"has_incomplete_action_items": false,
"has_unread_notes": false,
"part_id": 10922
}
],
"meta": {"current_page": 1,
"from": 1,
"to": 50,
"total": 100,
"per_page": 50
}
}

Create a NCR record

Authorizations:

bearerAuth

Request Body schema: application/json

ncr_number required	string
source required	string Enum: "internal" "customer" "supplier"
lot_number	string
quantity	integer
description	string
immediate_action	string
is_root_cause_determined	boolean
has_incomplete_action_items	boolean
has_unread_notes	boolean
part_id	string