The Quality Inspection object

Attributes

id string

Unique identifier for the object.

created_at string

ISO 8601 timestamp of when the object was created.

updated_at string

ISO 8601 timestamp of when the object was last updated.

status string

Default: draft

report_date string required
inspection_type string required
reference_type string required
reference_name string required
item_code string required
item_serial_no string
batch_no string
sample_size number required
item_name string
description string
inspected_by string

Default: user

verified_by string
bom_no string
remarks string
quality_inspection_template string
manual_inspection boolean

Default: false

child_row_reference string
company string
letter_head string
The Quality Inspection object 
{
  "id": "quality-inspection_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "report_date": "2024-01-15",
  "inspection_type": "inspection_type_example",
  "reference_type": "reference_type_example",
  "reference_name": "reference_name_example",
  "item_code": "item_code_example",
  "item_serial_no": "item_serial_no_example",
  "batch_no": "batch_no_example",
  "sample_size": 0,
  "item_name": "item_name_example",
  "description": "description_example",
  "inspected_by": "user",
  "verified_by": "verified_by_example",
  "bom_no": "bom_no_example",
  "remarks": "remarks_example",
  "quality_inspection_template": "quality_inspection_template_example",
  "manual_inspection": false,
  "child_row_reference": "child_row_reference_example",
  "company": "Example Corp",
  "letter_head": "letter_head_example"
}
GET /api/stock/quality-inspection/{id}

Retrieve a quality inspection

Retrieves the details of an existing quality inspection. Supply the unique quality inspection ID that was returned from a previous request.

Path parameters

id string required

The identifier of the quality inspection to retrieve.

Returns

Returns the quality inspection object if a valid identifier was provided.

GET /api/stock/quality-inspection/{id} 
curl https://api.overplane.dev/api/stock/quality-inspection/quality-inspection_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "quality-inspection_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "report_date": "2024-01-15",
  "inspection_type": "inspection_type_example",
  "reference_type": "reference_type_example",
  "reference_name": "reference_name_example",
  "item_code": "item_code_example",
  "item_serial_no": "item_serial_no_example",
  "batch_no": "batch_no_example",
  "sample_size": 0,
  "item_name": "item_name_example",
  "description": "description_example",
  "inspected_by": "user",
  "verified_by": "verified_by_example",
  "bom_no": "bom_no_example",
  "remarks": "remarks_example",
  "quality_inspection_template": "quality_inspection_template_example",
  "manual_inspection": false,
  "child_row_reference": "child_row_reference_example",
  "company": "Example Corp",
  "letter_head": "letter_head_example"
}
GET /api/stock/quality-inspection

List all quality inspections

Returns a list of quality inspections. The results are sorted by creation date, with the most recently created appearing first.

Query parameters

limit integer

Maximum number of objects to return. Default: 20.

offset integer

Number of objects to skip for pagination. Default: 0.

Returns

A paginated list of quality inspection objects.

GET /api/stock/quality-inspection 
curl https://api.overplane.dev/api/stock/quality-inspection \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "quality-inspection_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "status": "draft",
      "report_date": "2024-01-15",
      "inspection_type": "inspection_type_example",
      "reference_type": "reference_type_example",
      "reference_name": "reference_name_example",
      "item_code": "item_code_example",
      "item_serial_no": "item_serial_no_example",
      "batch_no": "batch_no_example",
      "sample_size": 0,
      "item_name": "item_name_example",
      "description": "description_example",
      "inspected_by": "user",
      "verified_by": "verified_by_example",
      "bom_no": "bom_no_example",
      "remarks": "remarks_example",
      "quality_inspection_template": "quality_inspection_template_example",
      "manual_inspection": false,
      "child_row_reference": "child_row_reference_example",
      "company": "Example Corp",
      "letter_head": "letter_head_example"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/stock/quality-inspection

Create a quality inspection

Creates a new quality inspection object.

Body parameters

status string

Default: draft

report_date string required
inspection_type string required
reference_type string required
reference_name string required
item_code string required
item_serial_no string
batch_no string
sample_size number required
item_name string
description string
inspected_by string

Default: user

verified_by string
bom_no string
remarks string
quality_inspection_template string
manual_inspection boolean

Default: false

child_row_reference string
company string
letter_head string

Returns

Returns the newly created quality inspection object if the call succeeded.

POST /api/stock/quality-inspection 
curl https://api.overplane.dev/api/stock/quality-inspection \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"report_date":"2024-01-15","inspection_type":"inspection_type_example","reference_type":"reference_type_example","reference_name":"reference_name_example","item_code":"item_code_example","sample_size":0}'
Response 
{
  "id": "quality-inspection_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "report_date": "2024-01-15",
  "inspection_type": "inspection_type_example",
  "reference_type": "reference_type_example",
  "reference_name": "reference_name_example",
  "item_code": "item_code_example",
  "item_serial_no": "item_serial_no_example",
  "batch_no": "batch_no_example",
  "sample_size": 0,
  "item_name": "item_name_example",
  "description": "description_example",
  "inspected_by": "user",
  "verified_by": "verified_by_example",
  "bom_no": "bom_no_example",
  "remarks": "remarks_example",
  "quality_inspection_template": "quality_inspection_template_example",
  "manual_inspection": false,
  "child_row_reference": "child_row_reference_example",
  "company": "Example Corp",
  "letter_head": "letter_head_example"
}
PATCH /api/stock/quality-inspection/{id}

Update a quality inspection

Updates the specified quality inspection by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Path parameters

id string required

The identifier of the quality inspection to update.

Body parameters

status string

Default: draft

report_date string
inspection_type string
reference_type string
reference_name string
item_code string
item_serial_no string
batch_no string
sample_size number
item_name string
description string
inspected_by string

Default: user

verified_by string
bom_no string
remarks string
quality_inspection_template string
manual_inspection boolean

Default: false

child_row_reference string
company string
letter_head string

Returns

Returns the updated quality inspection object.

PATCH /api/stock/quality-inspection/{id} 
curl https://api.overplane.dev/api/stock/quality-inspection/quality-inspection_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"status":"draft","report_date":"2024-01-15"}'
Response 
{
  "id": "quality-inspection_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "report_date": "2024-01-15",
  "inspection_type": "inspection_type_example",
  "reference_type": "reference_type_example",
  "reference_name": "reference_name_example",
  "item_code": "item_code_example",
  "item_serial_no": "item_serial_no_example",
  "batch_no": "batch_no_example",
  "sample_size": 0,
  "item_name": "item_name_example",
  "description": "description_example",
  "inspected_by": "user",
  "verified_by": "verified_by_example",
  "bom_no": "bom_no_example",
  "remarks": "remarks_example",
  "quality_inspection_template": "quality_inspection_template_example",
  "manual_inspection": false,
  "child_row_reference": "child_row_reference_example",
  "company": "Example Corp",
  "letter_head": "letter_head_example"
}
DELETE /api/stock/quality-inspection/{id}

Delete a quality inspection

Permanently deletes a quality inspection. This cannot be undone.

Path parameters

id string required

The identifier of the quality inspection to delete.

Returns

Returns a confirmation that the quality inspection has been deleted.

DELETE /api/stock/quality-inspection/{id} 
curl https://api.overplane.dev/api/stock/quality-inspection/quality-inspection_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "quality-inspection_abc123",
  "deleted": true
}
POST /api/stock/quality-inspection/{id}/submit

Submit a quality inspection

Submits a draft quality inspection, transitioning its status from draft to submitted.

Path parameters

id string required

The identifier of the quality inspection to act on.

Returns

Returns the quality inspection object with updated status.

POST /api/stock/quality-inspection/{id}/submit 
curl https://api.overplane.dev/api/stock/quality-inspection/quality-inspection_abc123/submit \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response 
{
  "id": "quality-inspection_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "report_date": "2024-01-15",
  "inspection_type": "inspection_type_example",
  "reference_type": "reference_type_example",
  "reference_name": "reference_name_example",
  "item_code": "item_code_example",
  "item_serial_no": "item_serial_no_example",
  "batch_no": "batch_no_example",
  "sample_size": 0,
  "item_name": "item_name_example",
  "description": "description_example",
  "inspected_by": "user",
  "verified_by": "verified_by_example",
  "bom_no": "bom_no_example",
  "remarks": "remarks_example",
  "quality_inspection_template": "quality_inspection_template_example",
  "manual_inspection": false,
  "child_row_reference": "child_row_reference_example",
  "company": "Example Corp",
  "letter_head": "letter_head_example"
}
POST /api/stock/quality-inspection/{id}/cancel

Cancel a quality inspection

Cancels a submitted quality inspection, transitioning its status to cancelled.

Path parameters

id string required

The identifier of the quality inspection to act on.

Returns

Returns the quality inspection object with updated status.

POST /api/stock/quality-inspection/{id}/cancel 
curl https://api.overplane.dev/api/stock/quality-inspection/quality-inspection_abc123/cancel \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response 
{
  "id": "quality-inspection_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "report_date": "2024-01-15",
  "inspection_type": "inspection_type_example",
  "reference_type": "reference_type_example",
  "reference_name": "reference_name_example",
  "item_code": "item_code_example",
  "item_serial_no": "item_serial_no_example",
  "batch_no": "batch_no_example",
  "sample_size": 0,
  "item_name": "item_name_example",
  "description": "description_example",
  "inspected_by": "user",
  "verified_by": "verified_by_example",
  "bom_no": "bom_no_example",
  "remarks": "remarks_example",
  "quality_inspection_template": "quality_inspection_template_example",
  "manual_inspection": false,
  "child_row_reference": "child_row_reference_example",
  "company": "Example Corp",
  "letter_head": "letter_head_example"
}

Line items

Child objects that belong to this quality inspection. These are accessed via the parent's ID.

Quality Inspection Reading

Attributes

idx integer
quality_inspection_id string required
specification string required
value string
reading_1 string
reading_2 string
reading_3 string
reading_4 string
reading_5 string
reading_6 string
reading_7 string
reading_8 string
reading_9 string
reading_10 string
status string
acceptance_formula string
formula_based_criteria boolean
min_value number
max_value number
reading_value string
manual_inspection boolean
numeric boolean
parameter_group string

Endpoints

GET /api/stock/quality-inspection-reading?parent_id={id}
POST /api/stock/quality-inspection-reading
PATCH /api/stock/quality-inspection-reading/{id}
DELETE /api/stock/quality-inspection-reading/{id}
POST /api/stock/quality-inspection-reading/reorder
Quality Inspection Reading object 
{
  "id": "quality-inspection-reading_abc123",
  "idx": 1,
  "quality_inspection_id": "quality_inspection_id_example",
  "specification": "specification_example",
  "value": "value_example",
  "reading_1": "reading_1_example",
  "reading_2": "reading_2_example",
  "reading_3": "reading_3_example",
  "reading_4": "reading_4_example",
  "reading_5": "reading_5_example",
  "reading_6": "reading_6_example",
  "reading_7": "reading_7_example",
  "reading_8": "reading_8_example",
  "reading_9": "reading_9_example",
  "reading_10": "reading_10_example",
  "status": "Accepted",
  "acceptance_formula": "acceptance_formula_example",
  "formula_based_criteria": false,
  "min_value": 0,
  "max_value": 0,
  "reading_value": "reading_value_example",
  "manual_inspection": false,
  "numeric": true,
  "parameter_group": "parameter_group_example"
}