Documentation Powered by ReDoc

ISOlocity API (2.6.0)

Download OpenAPI specification:Download

Terms of Service

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

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

Content type
application/json
{
  • "status": "success",
  • "message": "The request was successful",
  • "meta": {
    },
  • "data": [
    ]
}

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

Content type
application/json
{
  • "status": "success",
  • "message": "The request was successful",
  • "meta": {
    },
  • "data": [
    ]
}

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

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

Content type
application/json
{
  • "status": "success",
  • "message": "The request was successful",
  • "data": {
    }
}

View information for a particular supplier

Authorizations:
bearerAuth
path Parameters
id
required
integer

The ID of the supplier to retrieve

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "The request was successful",
  • "data": {
    }
}

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

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

Content type
application/json
{
  • "status": "success",
  • "message": "The request was successful",
  • "data": {
    }
}

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

Content type
application/json
{}

View information for a particular inventory

Authorizations:
bearerAuth
path Parameters
id
required
integer

The ID of the inventory to retrieve

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "The request was successful",
  • "data": {
    }
}

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

Content type
application/json
{
  • "status": "success",
  • "message": "The request was successful",
  • "data": {
    }
}

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

Content type
application/json
{
  • "status": "success",
  • "message": "The request was successful",
  • "data": [
    ],
  • "meta": {
    }
}

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

Responses

Request samples

Content type
application/json
{
  • "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
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "The request was successful",
  • "meta": {
    },
  • "data": {
    }
}

Retrieve a single NCR by ID

Authorizations:
bearerAuth
path Parameters
id
required
integer

The ID of the NCR to retrieve

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "The request was successful",
  • "data": {
    }
}

Update an existing NCR record

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64>

The id of the Ncr to update

Request Body schema: application/json
ncr_number
string

Report number

source
string

Report source (Options "Internal", "Customer", "Supplier")

esignature_password
string

Only if required setting is turned on

esignature_reason
string

Only if required reason setting is turned on

lot_number
string

Lot number

quantity
integer

Quantity

description
string

Description

immediate_action
string

Immediate action description

is_root_cause_determined
boolean

Is root cause determined (bool)

has_incomplete_action_items
boolean

Has incmplete actions (bool)

has_unread_notes
boolean

Has unread notes (bool)

part_id
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "ncr_number": "jan_16_2023_2",
  • "source": "internal",
  • "esignature_password": 12345,
  • "esignature_reason": "New data",
  • "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
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "The request was successful",
  • "meta": {
    },
  • "data": {
    }
}

Orders

List existing orders 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

Content type
application/json
{
  • "status": "success",
  • "message": "The request was successful",
  • "meta": {
    },
  • "data": [
    ]
}

Create a new order

Authorizations:
bearerAuth
Request Body schema: application/json
po_number
string

PO customer number

contact_id
integer

Customer id

order_date
string

Order date yyyy-mm-dd

serial_number
string

Lot

order_number
integer

Order number

is_closed
boolean

If order is closed. Default false

Responses

Request samples

Content type
application/json
{
  • "po_number": "jan12_2023_1",
  • "contact_id": 616,
  • "order_date": "2023-01-12T00:00:00.000Z",
  • "serial_number": 123456789999,
  • "order_number": 1324354657,
  • "is_closed": false
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "The request was successful",
  • "data": {
    }
}

View information for a particular order

Authorizations:
bearerAuth
path Parameters
id
required
integer

The ID of the order to retrieve

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "The request was successful",
  • "data": {
    }
}

Update an existing order

Authorizations:
bearerAuth
path Parameters
id
required
integer

The ID of the order to update

Request Body schema: application/json
po_number
string

PO customer number

contact_id
integer

Customer id

order_date
string

Order date yyyy-mm-dd

serial_number
string

Lot

order_number
integer

Order number

is_closed
boolean

If order is closed. Default false

Responses

Request samples

Content type
application/json
{
  • "po_number": "jan12_2023_1",
  • "contact_id": 616,
  • "order_date": "2023-01-12T00:00:00.000Z",
  • "serial_number": 123456789999,
  • "order_number": 1324354657,
  • "is_closed": false
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "The request was successful",
  • "data": {
    }
}

Parts

List existing parts 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

Content type
application/json
{
  • "status": "success",
  • "message": "The request was successful",
  • "meta": {
    },
  • "data": [
    ]
}

Create a new part

Authorizations:
bearerAuth
Request Body schema: application/json
name
string
company_id
integer
is_activity
boolean

If is a part set this as false, activity true

identification
string
is_finished_product
boolean
batch_ids
Array of strings
supplier_id
integer
parent_part_id
integer
unit_type
string
unit_of_measure
string
density
number
density_mass_unit
string
density_volume_unit
string

Responses

Request samples

Content type
application/json
{
  • "name": "Blue Juice (500 mL)",
  • "company_id": 1,
  • "is_activity": false,
  • "identification": "BJUICE500",
  • "is_finished_product": true,
  • "batch_ids": [
    ],
  • "supplier_id": 123,
  • "parent_part_id": 123,
  • "unit_type": "Volume",
  • "unit_of_measure": "ml",
  • "density": 0.314,
  • "density_mass_unit": "g",
  • "density_volume_unit": "ml"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "The request was successful",
  • "data": {
    }
}

View information for a particular part

Authorizations:
bearerAuth
path Parameters
id
required
integer

The ID of the part to retrieve

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "The request was successful",
  • "data": {
    }
}

Update an existing part

Authorizations:
bearerAuth
path Parameters
id
required
integer

The ID of the part to update

Request Body schema: application/json
name
string
identification
string

Responses

Request samples

Content type
application/json
{
  • "name": "Blue Juice (500 mL)",
  • "identification": "BJUICE500"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "The request was successful",
  • "data": {
    }
}

Create multiple new parts

Authorizations:
bearerAuth
Request Body schema: application/json
Array
name
required
string
company_id
integer
identification
required
string
is_activity
boolean
is_finished_product
boolean
batch_ids
Array of strings
supplier_id
integer
parent_part_id
integer
unit_type
string
unit_of_measure
string
density
number
density_mass_unit
string
density_volume_unit
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "The request was successful",
  • "meta": {
    },
  • "data": [
    ]
}

Update multiple existing parts

Authorizations:
bearerAuth
Request Body schema: application/json
Array
id
integer
name
required
string
identification
required
string
is_activity
boolean

If is a part set this as false, activity true

is_finished_product
boolean
Default: true
supplier_id
integer
parent_part_id
integer
batch_ids
array
unit_type
string
Enum: "Volume" "Mass" "Length"
unit_of_measure
string
Enum: "gal" "cup" "tsp" "l" "ml" "g" "kg" "lb" "t" "oz" "st" "m" "ft" "in" "yd" "cm" "mm" "units"
density
number
density_mass_unit
string
Enum: "g" "kg" "lb" "t" "oz" "st"
density_volume_unit
string
Enum: "gal" "cup" "tsp" "l" "ml"
created_at
string <date-time>
updated_at
string <date-time>

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "The request was successful",
  • "meta": {
    },
  • "data": [
    ]
}

Inspections

List existing inspections 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

Content type
application/json
{
  • "status": "success",
  • "message": "The request was successful",
  • "meta": {
    },
  • "data": {
    }
}

Create a new inspection

Authorizations:
bearerAuth
Request Body schema: application/json
id
string <integer>
entity_id
string <integer>

Id of inspection entity. For example id of part

entity_type
string

Entity type part or equipment. Most cases is part

drawing_id
string <integer>

Id of the template used by inspection

sample_size
integer

Quantity of samples in inspection. Minimum 1

is_create_batch_records
boolean

If needs to create natch record. Recommended set to true

passed
boolean

Is inspection finalized, passed or not started. If not started set as null

Responses

Request samples

Content type
application/json
{
  • "id": 1050,
  • "entity_id": 234,
  • "entity_type": "part",
  • "drawing_id": 32,
  • "sample_size": 1,
  • "is_create_batch_records": true,
  • "passed": true
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "The request was successful",
  • "data": {
    }
}

View information for a particular inspection

Authorizations:
bearerAuth
path Parameters
id
required
integer

The ID of the inspection to retrieve

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "The request was successful",
  • "data": {
    }
}

Update an existing inspection

Authorizations:
bearerAuth
path Parameters
id
required
integer

The ID of the inspection which will be updated

Request Body schema: application/json
passed
boolean

Is inspection finalized, passed or not started. If not started set as null

Responses

Request samples

Content type
application/json
{
  • "passed": true
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "The request was successful",
  • "data": {
    }
}

Inspections Samples

Create a new inspection sample

Authorizations:
bearerAuth
path Parameters
id
required
integer

The ID of the inspection to add sample to

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "The request was successful",
  • "data": {
    }
}

Update an existing inspection sample

Authorizations:
bearerAuth
path Parameters
id
required
integer

The ID of the inspection containing the sample

sample_id
required
integer

The ID of the sample

Request Body schema: application/json
sample_serial
string

The serial string that identifies the sample

sample_number
integer

The number reference of sample. If there are 6 samples in inspection, one could be 5

Array of objects[ items ]

All characteristics contained in this sample

Responses

Request samples

Content type
application/json
{
  • "sample_serial": "string",
  • "sample_number": 5,
  • "results": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "The request was successful",
  • "data": {
    }
}

Delete sample from a inspection

Authorizations:
bearerAuth
path Parameters
id
required
integer

The ID of the inspection containing the sample

sample_id
required
integer

The ID of the sample

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "The request was successful"
}

Corrective Action Reports (CARs)

List existing CARs 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

Content type
application/json
{
  • "status": "success",
  • "message": "The request was successful",
  • "meta": {
    },
  • "data": [
    ]
}

Create a new CAR

Authorizations:
bearerAuth
Request Body schema: application/json
car_number
string

Responses

Request samples

Content type
application/json
{
  • "car_number": "AUD-151"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "The request was successful",
  • "data": {
    }
}

View information for a paricular CAR

Authorizations:
bearerAuth
path Parameters
id
required
integer

The ID of the CAR to retrieve

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "The request was successful",
  • "data": {
    }
}

Update an existing CAR

Authorizations:
bearerAuth
path Parameters
id
required
integer

The ID of the CAR to update

Request Body schema: application/json
car_number
string

Responses

Request samples

Content type
application/json
{
  • "car_number": "AUD-151"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "The request was successful",
  • "data": {
    }
}

ShipmentItems

Add a new item to a shipment

Authorizations:
bearerAuth
path Parameters
shipment_id
required
integer

The ID of the shipment to which the item should be added

Request Body schema: application/json
part_id
integer

Part id to be added to the shipment

quantity
integer

Quantity of this part

serial_number
string

Lot

drawing_id
integer

The drawing/template to be used with this part. Can be retrieved from Drawings endpoint

order
integer

In which arrangement position the parts will display in the order (For example, position 1). Default autoincrease

Responses

Request samples

Content type
application/json
{
  • "part_id": 10664,
  • "quantity": 5,
  • "serial_number": 1122,
  • "drawing_id": 952,
  • "order": 2
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "The request was successful",
  • "data": {
    }
}

Update a shipment item

Authorizations:
bearerAuth
path Parameters
shipment_id
required
integer

The ID of the shipment to which the item belongs

id
required
integer

The ID of the shipment item to update

Request Body schema: application/json
part_id
integer

ID of the part to be added to the shipment

quantity
integer

Quantity of this part

serial_number
string

Lot

drawing_id
integer

ID of the drawing/template to be used with this part. Can be retrieved from Drawings endpoint

order
integer

In which arrangement position the parts will display in the order (For example, position 1). Default autoincrease

Responses

Request samples

Content type
application/json
{
  • "part_id": 10664,
  • "quantity": 10,
  • "serial_number": 1122,
  • "drawing_id": 952,
  • "order": 2
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "The request was successful",
  • "data": {
    }
}

Specifications

List existing specifications 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

identification
string
Example: identification=SAMPLE123

The user assigned identification of the template

keyword
string
Example: keyword=Daily Inspection Template

Keyword that matches template name or identification

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "The request was successful",
  • "meta": {
    },
  • "data": [
    ]
}

View information for a particular specification

Authorizations:
bearerAuth
path Parameters
id
required
integer

The ID of the specification to retrieve

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "The request was successful",
  • "data": {
    }
}

Lab Results

Create a new lab result

Authorizations:
bearerAuth
Request Body schema: application/json
id
integer
specification_id
integer
testing_id
string
testing_date
string <date>
inspector_name
string
batch_number
string
package_id
string
product_name
string
lab_data
string

Responses

Request samples

Content type
application/json
{
  • "id": 123,
  • "specification_id": 456,
  • "testing_id": "TEST123",
  • "testing_date": "2016-11-04",
  • "inspector_name": "Joe Smith",
  • "batch_number": "BATCH123",
  • "package_id": "PACKAGE123",
  • "product_name": "Banana Flower",
  • "lab_data": "{'moisture_content_percent':'5.25','moisture_content_water_activity_rate':'11.00001'}"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "The request was successful",
  • "data": {
    }
}

View information for a particular lab result

Authorizations:
bearerAuth
path Parameters
id
required
integer

The ID of the specification to retrieve

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "The request was successful",
  • "data": {
    }
}

Update an existing lab result

Authorizations:
bearerAuth
path Parameters
id
required
integer

The ID of the lab result to update

Request Body schema: application/json
testing_id
string
testing_date
string <date>
inspector_name
string
batch_number
string
package_id
string
product_name
string
lab_data
string

Responses

Request samples

Content type
application/json
{
  • "testing_id": "TEST123",
  • "testing_date": "2016-11-04",
  • "inspector_name": "Joe Smith",
  • "batch_number": "BATCH123",
  • "package_id": "PACKAGE123",
  • "product_name": "Banana Flower",
  • "lab_data": "{'moisture_content_percent':'5.25','moisture_content_water_activity_rate':'11.00001'}"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "The request was successful",
  • "data": {
    }
}

Complaints

List of existing initiated complaint 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

Content type
application/json
{
  • "status": "success",
  • "message": "The request was successful",
  • "meta": {
    },
  • "data": [
    ]
}

Initiate a new complaint.

Authorizations:
bearerAuth
Request Body schema: application/json
complaint_number
required
string
complaint_date
required
string <date>
part_id
integer
error_code_id
integer
received_by
string
received_via
string
strain_name
string
batch_number
string
store_info
string
comments
string
complainant_full_name
string
complainant_address
string
complainant_phone
string
complainant_email
string
complainant_fax
string

Responses

Request samples

Content type
application/json
{
  • "complaint_number": 123,
  • "complaint_date": "2016-11-04",
  • "part_id": 10,
  • "error_code_id": 15,
  • "received_by": "Jhone Doe",
  • "received_via": "Phone",
  • "strain_name": "Strain",
  • "batch_number": "BATCH123",
  • "store_info": "Store information goes here",
  • "comments": "Comments from complaint goes here",
  • "complainant_full_name": "Jane Doe",
  • "complainant_address": "111 street name, city, province, Country",
  • "complainant_phone": "1234567890",
  • "complainant_email": "jane@doe.com",
  • "complainant_fax": "12345"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "The request was successful",
  • "data": {
    }
}

View information for a particular complaint

Authorizations:
bearerAuth
path Parameters
id
required
integer

The ID of the complaint to retrieve

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "The request was successful",
  • "data": {
    }
}

Update an existing complaint record

Authorizations:
bearerAuth
path Parameters
id
required
integer

The ID of the complaint record to update

Request Body schema: application/json
complaint_number
required
string
complaint_date
required
string <date>
part_id
integer
error_code_id
integer
received_by
string
received_via
string
strain_name
string
batch_number
string
store_info
string
comments
string
complainant_full_name
string
complainant_address
string
complainant_phone
string
complainant_email
string
complainant_fax
string

Responses

Request samples

Content type
application/json
{
  • "complaint_number": 123,
  • "complaint_date": "2016-11-04",
  • "part_id": 10,
  • "error_code_id": 15,
  • "received_by": "Jhone Doe",
  • "received_via": "Phone",
  • "strain_name": "Strain",
  • "batch_number": "BATCH123",
  • "store_info": "Store information goes here",
  • "comments": "Comments from complaint goes here",
  • "complainant_full_name": "Jane Doe",
  • "complainant_address": "111 street name, city, province, Country",
  • "complainant_phone": "1234567890",
  • "complainant_email": "jane@doe.com",
  • "complainant_fax": "12345"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "The request was successful",
  • "data": {
    }
}

OrderItems

Add new item to an order

Authorizations:
bearerAuth
path Parameters
order_id
required
integer

The ID of the order to which the item should be added

Request Body schema: application/json
order_id
integer

Required, Order id to which the item belongs to

part_id
integer

Required, Part id to be added to the order

quantity
number

Required, Quantity of this part

serial_number
any

Required, Lot

drawing_id
integer

Optional, The drawing/template to be used with this part. Can be retrieved from Drawings endpoint

is_low_inventory
boolean

Option, Establish if inventory is low or not. Default false

is_low_materials
boolean

Optional, Establish if is low on materials. Default false

order
boolean

Optional, In which arragement position the parts will display in the order (For example, position 1). Default, autoincrease

Responses

Request samples

Content type
application/json
{
  • "order_id": 10664,
  • "part_id": 115,
  • "quantity": 10,
  • "serial_number": "test_mar_8_2023_2",
  • "drawing_id": 2,
  • "is_low_inventory": 2,
  • "is_low_materials": 2,
  • "order": 1
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "The request was successful",
  • "data": {
    }
}

Edit existing item of an order

Authorizations:
bearerAuth
path Parameters
order_id
required
any

The ID of the order to which the item should be modified

id
required
any

The ID of the order item to modify

Request Body schema: application/json
order_id
integer

Required, Order id to which the item belongs to

part_id
integer

Required, Part id to be added to the order

quantity
number

Required, Quantity of this part

serial_number
any

Required, Lot

drawing_id
integer

Optional, The drawing/template to be used with this part. Can be retrieved from Drawings endpoint

is_low_inventory
boolean

Option, Establish if inventory is low or not. Default false

is_low_materials
boolean

Optional, Establish if is low on materials. Default false

order
boolean

Optional, In which arragement position the parts will display in the order (For example, position 1). Default, autoincrease

Responses

Request samples

Content type
application/json
{
  • "order_id": 10664,
  • "part_id": 115,
  • "quantity": 10,
  • "serial_number": "test_mar_8_2023_2",
  • "drawing_id": 2,
  • "is_low_inventory": 2,
  • "is_low_materials": 2,
  • "order": 1
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "The request was successful",
  • "data": {
    }
}

Receiving Inspection Items

Update an existing Receiving Inspection Item

Authorizations:
bearerAuth
path Parameters
receiving_inspection_id
required
integer

The ID of the Receiving inspection parent to the item belongs

id
required
integer <int64>

The id of the Receiving Inspection Item to update

Request Body schema: application/json
receiving_inspection_id
integer

RI to link to

part_id
integer

Part id to be added to the RI

quantity_accepted
number

quantity for inspection, Double or Int

quantity_rejected
number

rejected quantity for inspection, Double or Int (Set 0 as default)

unit_of_measure
string

unit of measure ( Options '%', 'amin', 'asec', 'c', 'cm', 'CBD%', 'cfu/g', 'Deg', 'EA', 'F', 'ft', 'gal', 'gal/min', 'grams', 'g/cm3', 'g/ml', 'hr', 'ht', 'Hv', 'Hz', 'in', 'in/sec', 'kg', 'kgf', 'km', 'l', 'lb', 'lot', 'm', 'm3', 'min', 'ml', 'mm', 'MPa', 'mg/g', 'mg/kg', 'N.m', 'Oz', 'psi', 'ppm', 'ppb', 'Ra', 'rad', 'rc', 'RPM', 'Sec', 'THC%', 'µg/kg', 'µg/g', 'Volts')

serial_number
string

Serial Number

order
integer

In which arragement position the parts will display in the order (For example, position 1). Default autoincrease

is_active_batch
boolean

Is an active batch? Bool

received_date
string

Optional, The received date for this specific item

drawing_id
integer

The drawing/template to be used with this part. Can be retrieved from Drawings endpoint

Responses

Request samples

Content type
application/json
{
  • "receiving_inspection_id": 531,
  • "part_id": 10664,
  • "quantity_accepted": 50,
  • "quantity_rejected": 0,
  • "unit_of_measure": "units",
  • "serial_number": 11223,
  • "order": 2,
  • "is_active_batch": false,
  • "received_date": "2021-07-04T00:00:00.000Z",
  • "drawing_id": 952
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "The request was successful",
  • "meta": {
    }
}

Add an item to a receiving inspection

Authorizations:
bearerAuth
path Parameters
receiving_inspection_id
required
integer <int64>

The id of the receiving inspection to add the item to

Request Body schema: application/json
part_id
integer <int64>

Part id to be added to the RI

quantity_accepted
number

Quantity for inspection

quantity_rejected
number

Quantity rejected for inspection

unit_of_measure
string

unit of measure ( Options '%', 'amin', 'asec', 'c', 'cm', 'CBD%', 'cfu/g', 'Deg', 'EA', 'F', 'ft', 'gal', 'gal/min', 'grams', 'g/cm3', 'g/ml', 'hr', 'ht', 'Hv', 'Hz', 'in', 'in/sec', 'kg', 'kgf', 'km', 'l', 'lb', 'lot', 'm', 'm3', 'min', 'ml', 'mm', 'MPa', 'mg/g', 'mg/kg', 'N.m', 'Oz', 'psi', 'ppm', 'ppb', 'Ra', 'rad', 'rc', 'RPM', 'Sec', 'THC%', 'µg/kg', 'µg/g', 'Volts')

serial_number
string

Serial Number

order
integer

In which arrangement position the parts will display in the order (For example, position 1)

is_active_batch
boolean

Is an active batch? Bool

cost
number

Optional, The item cost

received_date
string

Optional, The received date for this specific item

drawing_id
integer <int64>

The drawing/template to be used with this part. Can be retrieved from Drawings endpoint

Responses

Request samples

Content type
application/json
{
  • "part_id": 10664,
  • "quantity_accepted": 10,
  • "quantity_rejected": 0,
  • "unit_of_measure": "units",
  • "serial_number": 1122,
  • "order": 2,
  • "is_active_batch": false,
  • "cost": 1500,
  • "received_date": "2021-07-04T00:00:00.000Z",
  • "drawing_id": 952
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "The request was successful",
  • "data": {
    }
}

Shipments

Retrieve a particular shipment

Authorizations:
bearerAuth
path Parameters
id
required
integer

The ID of the shipment to retrieve

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "The request was successful",
  • "data": {
    }
}

Update an existing shipment

Authorizations:
bearerAuth
path Parameters
id
required
integer

The ID of the shipment to update

Request Body schema: application/x-www-form-urlencoded
requested_ship_date
string <date>

Requested shipdate yyyy-mm-dd

actual_ship_date
string <date>

Optional, Actual shipdate yyyy-mm-dd (If set, will close the shipment)

po_number
string

Optional, Lot number OR serial number

contact_id
integer

Optional, Customer id

notes
string

Optional, shipment notes

order_id
integer

Optional, Existing order id (You should know this, after the shipment got created, use the order_id returned by api)

is_ship_all_items
boolean

Will all items ship at the same date and time?

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "The request was successful",
  • "data": {
    }
}

Retrieve a list of shipments

Authorizations:
bearerAuth
query Parameters
dateRange
required
boolean
Example: dateRange=true

Either true or false

fromDate
required
string <date>
Example: fromDate=2021-03-01

Can be empty or date format yyyy-mm-dd

toDate
required
string <date>
Example: toDate=2023-01-12

Can be empty or date format yyyy-mm-dd

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "The request was successful",
  • "data": [
    ]
}

Create a new shipment

Authorizations:
bearerAuth
Request Body schema: application/x-www-form-urlencoded
requested_ship_date
string <date>

Requested shipdate yyyy-mm-dd

contact_id
integer

Optional, Customer id

order_id
integer

Optional, Existing order id (retrieve from orders API)

po_number
string

Optional, Lot number OR serial number

is_ship_all_items
boolean

Will all items ship at the same date and time?

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "The request was successful",
  • "data": {
    }
}

Receiving Inspections

List existing receiving inspections 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

Content type
application/json
{
  • "status": "success",
  • "message": "The request was successful",
  • "meta": {
    },
  • "data": [
    ]
}

Create a new receiving inspection

Authorizations:
bearerAuth
Request Body schema: application/json
supplier_id
integer
serial_number
string
po_number
string
requested_shipment_arrival_date
string
actual_arrival_date
string
is_closed
boolean
is_quarantined
boolean
total_order_quantity
number
is_receive_all_items
boolean

Will all items be received at the same date and time?

notes
string
Array of objects[ items ]

Responses

Request samples

Content type
application/json
{
  • "supplier_id": 1024,
  • "serial_number": "S123456",
  • "po_number": "PO123456",
  • "requested_shipment_arrival_date": "2016-11-04",
  • "actual_arrival_date": "2016-11-08",
  • "is_closed": 0,
  • "is_quarantined": 1,
  • "total_order_quantity": 10,
  • "is_receive_all_items": true,
  • "notes": "Here are some notes about the order",
  • "items": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "The request was successful",
  • "data": {
    }
}

View information for a particular receiving inspection

Authorizations:
bearerAuth
path Parameters
id
required
integer

The ID of the receiving inspection to retrieve

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "The request was successful",
  • "data": {
    }
}

Update an existing receiving inspection

Authorizations:
bearerAuth
path Parameters
id
required
integer

The ID of the receiving inspection which will be updated

Request Body schema: application/json
id
integer
supplier_id
integer
serial_number
string
po_number
string
requested_shipment_arrival_date
string
actual_arrival_date
string
is_closed
boolean
is_quarantined
boolean
total_order_quantity
number
is_receive_all_items
boolean

Will all items be received at the same date and time?

notes
string
Array of objects[ items ]

Responses

Request samples

Content type
application/json
{
  • "id": 1024,
  • "supplier_id": 1024,
  • "serial_number": "S123456",
  • "po_number": "PO123456",
  • "requested_shipment_arrival_date": "2016-11-04",
  • "actual_arrival_date": "2016-11-08",
  • "is_closed": 0,
  • "is_quarantined": 1,
  • "total_order_quantity": 10,
  • "is_receive_all_items": true,
  • "notes": "Here are some notes about the order",
  • "items": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "The request was successful",
  • "data": {
    }
}

PartTypes

View information for a particular part-type

Authorizations:
bearerAuth
path Parameters
id
required
integer

The ID of the part-type to retrieve

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "The request was successful",
  • "data": {
    }
}

Update an existing part-type

Authorizations:
bearerAuth
path Parameters
id
required
integer

The ID of the part-type to update

Request Body schema: application/json
name
string
is_active
number

Is the type active (1) or not (0)

Responses

Request samples

Content type
application/json
{
  • "name": "Part Type Name",
  • "is_active": 1
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "The request was successful",
  • "data": {
    }
}

List existing part-types in the authorized user's organization

Authorizations:
bearerAuth
query Parameters
page
integer
Example: page=1

The current page of data

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "The request was successful",
  • "meta": {
    },
  • "data": [
    ]
}

Create a new part-type

Authorizations:
bearerAuth
Request Body schema: application/json
name
string
is_active
number

Is the type active (1) or not (0)

Responses

Request samples

Content type
application/json
{
  • "name": "Part Type Name",
  • "is_active": 1
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "The request was successful",
  • "data": {
    }
}

Locations

View information for a particular location

Authorizations:
bearerAuth
path Parameters
id
required
integer

The ID of the location to retrieve

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "The request was successful",
  • "data": {
    }
}

Update an existing location

Authorizations:
bearerAuth
path Parameters
id
required
integer

The ID of the location to update

Request Body schema: application/json
name
string
is_active
number

Is the locaton active (1) or not (0)

Responses

Request samples

Content type
application/json
{
  • "name": "Location Name",
  • "is_active": 1
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "The request was successful",
  • "data": {
    }
}

List existing locations in the authorized user's organization

Authorizations:
bearerAuth
query Parameters
page
integer
Example: page=1

The current page of data

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "The request was successful",
  • "meta": {
    },
  • "data": [
    ]
}

Create a new location

Authorizations:
bearerAuth
Request Body schema: application/json
name
string
is_active
number

Is the location active (1) or not (0)

Responses

Request samples

Content type
application/json
{
  • "name": "Location Name",
  • "is_active": 1
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "The request was successful",
  • "data": {
    }
}

Customers

List existing customers 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

Content type
application/json
{
  • "status": "success",
  • "message": "The request was successful",
  • "meta": {
    },
  • "data": [
    ]
}

Create a new customer

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
street
string
city
string
province
string
country
string
postal_code
string
custom_field_1
string
custom_field_2
string

Responses

Request samples

Content type
application/json
{
  • "name": "Customers Inc.",
  • "primary_name": "John Smith",
  • "primary_email": "johnsmith@customers.com",
  • "primary_phone": "1-649-123-4567",
  • "primary_position": "Sales Director",
  • "secondary_name": "Jane Smith",
  • "secondary_email": "janesmith@abc.com",
  • "secondary_phone": "1-649-123-4567",
  • "secondary_position": "CEO",
  • "street": "Test Street 1",
  • "city": "Toronto",
  • "province": "Ontario",
  • "country": "Canada",
  • "postal_code": "n4n4n4",
  • "custom_field_1": "Custom value 2",
  • "custom_field_2": "Custom value 2"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "The request was successful",
  • "data": {
    }
}

View information for a particular customer

Authorizations:
bearerAuth
path Parameters
id
required
integer

The ID of the customer to retrieve

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "The request was successful",
  • "data": {
    }
}

Update an existing customer

Authorizations:
bearerAuth
path Parameters
id
required
integer

The ID of the customer 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
street
string
city
string
province
string
country
string
postal_code
string
custom_field_1
string
custom_field_2
string

Responses

Request samples

Content type
application/json
{
  • "name": "Customers Inc.",
  • "primary_name": "John Smith",
  • "primary_email": "johnsmith@customers.com",
  • "primary_phone": "1-649-123-4567",
  • "primary_position": "Sales Director",
  • "secondary_name": "Jane Smith",
  • "secondary_email": "janesmith@abc.com",
  • "secondary_phone": "1-649-123-4567",
  • "secondary_position": "CEO",
  • "street": "Test Street 1",
  • "city": "Toronto",
  • "province": "Ontario",
  • "country": "Canada",
  • "postal_code": "n4n4n4",
  • "custom_field_1": "Custom value 2",
  • "custom_field_2": "Custom value 2"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "The request was successful",
  • "data": {
    }
}

Employees

List existing employees in the authorized user's organization

Authorizations:
bearerAuth
query Parameters
page
integer
Example: page=1

The current page of data

is_active
integer
Example: is_active=1

Filter by active or inactive data

keyword
string
Example: keyword=keyword

Filter by keyword data

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "The request was successful",
  • "meta": {
    },
  • "data": [
    ]
}

View information for a particular employee

Authorizations:
bearerAuth
path Parameters
id
required
integer

The ID of the employees to retrieve

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "The request was successful",
  • "data": {
    }
}

Update an existing employee

Authorizations:
bearerAuth
path Parameters
id
required
integer

The ID of the employees to update

Request Body schema: application/json
first_name
string
last_name
string
is_active
boolean
position
string
phone_number
string
email_address
string
address
string
next_review_date
string

Optional, Employee next review date

review_repeat_duration
string

Optional, Employee review duration (For example Days, Weeks or Months )

review_repeat_frequency
string

Optional, Employee review frequency rate (For example 1, 2 .. connected with duration would be "2 Months")

notes
string

Responses

Request samples

Content type
application/json
{
  • "first_name": "John",
  • "last_name": "Smith",
  • "is_active": true,
  • "position": "Sales Director",
  • "phone_number": 9999999999,
  • "email_address": "janesmith@abc.com",
  • "address": "Toronto",
  • "next_review_date": "2023-04-10T00:00:00.000Z",
  • "review_repeat_duration": "Months",
  • "review_repeat_frequency": 2,
  • "notes": "Notes here"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "The request was successful",
  • "data": {
    }
}