cURL
curl --request PUT \
--url https://app.stockshift.io/api/v1/quality/plans/{plan} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"characteristics": [
{
"name": "<string>",
"key": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"nominal": "<string>",
"lower": "<string>",
"upper": "<string>",
"unit": "<string>",
"choices": [
"<string>"
],
"accepted": [
"<string>"
]
}
]
}
'import requests
url = "https://app.stockshift.io/api/v1/quality/plans/{plan}"
payload = {
"name": "<string>",
"characteristics": [
{
"name": "<string>",
"key": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"nominal": "<string>",
"lower": "<string>",
"upper": "<string>",
"unit": "<string>",
"choices": ["<string>"],
"accepted": ["<string>"]
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.stockshift.io/api/v1/quality/plans/{plan}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'characteristics' => [
[
'name' => '<string>',
'key' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'nominal' => '<string>',
'lower' => '<string>',
'upper' => '<string>',
'unit' => '<string>',
'choices' => [
'<string>'
],
'accepted' => [
'<string>'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.stockshift.io/api/v1/quality/plans/{plan}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"characteristics\": [\n {\n \"name\": \"<string>\",\n \"key\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"nominal\": \"<string>\",\n \"lower\": \"<string>\",\n \"upper\": \"<string>\",\n \"unit\": \"<string>\",\n \"choices\": [\n \"<string>\"\n ],\n \"accepted\": [\n \"<string>\"\n ]\n }\n ]\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"data": {
"id": "<string>",
"name": "<string>",
"point": "<string>",
"item_id": "<string>",
"item_sku": "<string>",
"item_name": "<string>",
"family_id": "<string>",
"family_name": "<string>",
"supplier_id": "<string>",
"supplier_code": "<string>",
"supplier_name": "<string>",
"work_center_id": "<string>",
"work_center_code": "<string>",
"work_center_name": "<string>",
"sampling": "<string>",
"sample_count": 123,
"inspection_level": "<string>",
"aql": "<string>",
"first_article": true,
"instructions": "<string>",
"characteristics": [
{
"key": "<string>",
"name": "<string>",
"kind": "pass_fail",
"nominal": "<string>",
"lower": "<string>",
"upper": "<string>",
"unit": "<string>",
"choices": [
"<string>"
],
"accepted": [
"<string>"
]
}
],
"archived": true,
"updated_at": "<string>"
}
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"detail": "<string>",
"errors": {},
"feature": "<string>",
"reason": "<string>",
"attempts_left": 123,
"rule_ids": [
"<string>"
],
"witness": "<string>",
"blind_recount": true,
"flags": [
{
"flag": "<string>",
"facts": {},
"choices": [
"<string>"
]
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"detail": "<string>",
"errors": {},
"feature": "<string>",
"reason": "<string>",
"attempts_left": 123,
"rule_ids": [
"<string>"
],
"witness": "<string>",
"blind_recount": true,
"flags": [
{
"flag": "<string>",
"facts": {},
"choices": [
"<string>"
]
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"detail": "<string>",
"errors": {},
"feature": "<string>",
"reason": "<string>",
"attempts_left": 123,
"rule_ids": [
"<string>"
],
"witness": "<string>",
"blind_recount": true,
"flags": [
{
"flag": "<string>",
"facts": {},
"choices": [
"<string>"
]
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"detail": "<string>",
"errors": {},
"feature": "<string>",
"reason": "<string>",
"attempts_left": 123,
"rule_ids": [
"<string>"
],
"witness": "<string>",
"blind_recount": true,
"flags": [
{
"flag": "<string>",
"facts": {},
"choices": [
"<string>"
]
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"detail": "<string>",
"errors": {},
"feature": "<string>",
"reason": "<string>",
"attempts_left": 123,
"rule_ids": [
"<string>"
],
"witness": "<string>",
"blind_recount": true,
"flags": [
{
"flag": "<string>",
"facts": {},
"choices": [
"<string>"
]
}
]
}Inspection plans
Replace an inspection plan
Inspections already open keep the characteristics they opened with.
Needs the quality.plans.manage permission, a token with quality:write
and a plan with quality inspections.
PUT
/
quality
/
plans
/
{plan}
cURL
curl --request PUT \
--url https://app.stockshift.io/api/v1/quality/plans/{plan} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"characteristics": [
{
"name": "<string>",
"key": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"nominal": "<string>",
"lower": "<string>",
"upper": "<string>",
"unit": "<string>",
"choices": [
"<string>"
],
"accepted": [
"<string>"
]
}
]
}
'import requests
url = "https://app.stockshift.io/api/v1/quality/plans/{plan}"
payload = {
"name": "<string>",
"characteristics": [
{
"name": "<string>",
"key": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"nominal": "<string>",
"lower": "<string>",
"upper": "<string>",
"unit": "<string>",
"choices": ["<string>"],
"accepted": ["<string>"]
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.stockshift.io/api/v1/quality/plans/{plan}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'characteristics' => [
[
'name' => '<string>',
'key' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'nominal' => '<string>',
'lower' => '<string>',
'upper' => '<string>',
'unit' => '<string>',
'choices' => [
'<string>'
],
'accepted' => [
'<string>'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.stockshift.io/api/v1/quality/plans/{plan}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"characteristics\": [\n {\n \"name\": \"<string>\",\n \"key\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"nominal\": \"<string>\",\n \"lower\": \"<string>\",\n \"upper\": \"<string>\",\n \"unit\": \"<string>\",\n \"choices\": [\n \"<string>\"\n ],\n \"accepted\": [\n \"<string>\"\n ]\n }\n ]\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"data": {
"id": "<string>",
"name": "<string>",
"point": "<string>",
"item_id": "<string>",
"item_sku": "<string>",
"item_name": "<string>",
"family_id": "<string>",
"family_name": "<string>",
"supplier_id": "<string>",
"supplier_code": "<string>",
"supplier_name": "<string>",
"work_center_id": "<string>",
"work_center_code": "<string>",
"work_center_name": "<string>",
"sampling": "<string>",
"sample_count": 123,
"inspection_level": "<string>",
"aql": "<string>",
"first_article": true,
"instructions": "<string>",
"characteristics": [
{
"key": "<string>",
"name": "<string>",
"kind": "pass_fail",
"nominal": "<string>",
"lower": "<string>",
"upper": "<string>",
"unit": "<string>",
"choices": [
"<string>"
],
"accepted": [
"<string>"
]
}
],
"archived": true,
"updated_at": "<string>"
}
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"detail": "<string>",
"errors": {},
"feature": "<string>",
"reason": "<string>",
"attempts_left": 123,
"rule_ids": [
"<string>"
],
"witness": "<string>",
"blind_recount": true,
"flags": [
{
"flag": "<string>",
"facts": {},
"choices": [
"<string>"
]
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"detail": "<string>",
"errors": {},
"feature": "<string>",
"reason": "<string>",
"attempts_left": 123,
"rule_ids": [
"<string>"
],
"witness": "<string>",
"blind_recount": true,
"flags": [
{
"flag": "<string>",
"facts": {},
"choices": [
"<string>"
]
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"detail": "<string>",
"errors": {},
"feature": "<string>",
"reason": "<string>",
"attempts_left": 123,
"rule_ids": [
"<string>"
],
"witness": "<string>",
"blind_recount": true,
"flags": [
{
"flag": "<string>",
"facts": {},
"choices": [
"<string>"
]
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"detail": "<string>",
"errors": {},
"feature": "<string>",
"reason": "<string>",
"attempts_left": 123,
"rule_ids": [
"<string>"
],
"witness": "<string>",
"blind_recount": true,
"flags": [
{
"flag": "<string>",
"facts": {},
"choices": [
"<string>"
]
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"detail": "<string>",
"errors": {},
"feature": "<string>",
"reason": "<string>",
"attempts_left": 123,
"rule_ids": [
"<string>"
],
"witness": "<string>",
"blind_recount": true,
"flags": [
{
"flag": "<string>",
"facts": {},
"choices": [
"<string>"
]
}
]
}Authorizations
apiKeyoauth2
For your own scripts and server-to-server integrations. Create a key in the app under Settings > Access > API keys and copy it then, because it is shown once. Send it as Authorization: Bearer <key>. The key acts as the member who made it, in the organization it was made in. A call needs the member's permission and one of the key's scopes, such as inventory:read or sales:write. A key with * has every scope.
Path Parameters
Body
application/json
An inspection plan to add or change.
Maximum string length:
120receipt, operation or build.
Available options:
receipt, operation, build all, fixed or aql.
Available options:
all, fixed, aql What it checks, 1 to 20.
Required array length:
1 - 20 elementsShow child attributes
Show child attributes
The item it inspects, by id or SKU. A receipt plan names an item, a family, a supplier or a mix; a build plan an item or a family.
Maximum string length:
64The item family it inspects, by id.
For a receipt plan, the supplier whose goods it inspects, by id or code.
Maximum string length:
64For an operation plan, the work center whose operations it inspects after, by id.
For a fixed sample, how many units.
Required range:
1 <= x <= 100000For AQL sampling, the MIL-STD-105E inspection level: S-1, S-2, S-3, S-4, I, II or III.
Available options:
S-1, S-2, S-3, S-4, I, II, III For AQL sampling, the AQL as MIL-STD-105E prints it, from 0.010 to 1000, such as 2.5.
Available options:
0.010, 0.015, 0.025, 0.040, 0.065, 0.10, 0.15, 0.25, 0.40, 0.65, 1.0, 1.5, 2.5, 4.0, 6.5, 10, 15, 25, 40, 65, 100, 150, 250, 400, 650, 1000, null Inspect only the first lot from each supplier, or of each BOM revision.
Maximum string length:
5000Response
PlanResource
Show child attributes
Show child attributes
Was this page helpful?