cURL
curl --request POST \
--url https://app.stockshift.io/api/v1/quality/inspections/{inspection}/files/{characteristic} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: multipart/form-data' \
--form file=@example-fileimport requests
url = "https://app.stockshift.io/api/v1/quality/inspections/{inspection}/files/{characteristic}"
files = { "file": ("example-file", open("example-file", "rb")) }
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, files=files, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.stockshift.io/api/v1/quality/inspections/{inspection}/files/{characteristic}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: multipart/form-data; boundary=---011000010111000001101001"
],
]);
$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/inspections/{inspection}/files/{characteristic}"
payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "multipart/form-data; boundary=---011000010111000001101001")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"data": {
"id": "<string>",
"number": "<string>",
"status": "<string>",
"point": "<string>",
"plan_name": "<string>",
"first_article": true,
"item_id": "<string>",
"item_sku": "<string>",
"item_name": "<string>",
"source_type": "<string>",
"source_id": "<string>",
"source_number": "<string>",
"source_detail": "<string>",
"lot": "<string>",
"serials": [
"<string>"
],
"quantity": "<string>",
"unit": "<string>",
"sample_size": 123,
"created_at": "<string>",
"recorded_at": "<string>",
"plan_id": "<string>",
"location_id": "<string>",
"location_code": "<string>",
"supplier_id": "<string>",
"supplier_name": "<string>",
"work_center_id": "<string>",
"work_center_name": "<string>",
"revision": "<string>",
"holds_stock": true,
"lot_size": 123,
"accept": 123,
"sampling": "<string>",
"inspection_level": "<string>",
"aql": "<string>",
"instructions": "<string>",
"characteristics": [
{
"key": "<string>",
"name": "<string>",
"kind": "pass_fail",
"nominal": "<string>",
"lower": "<string>",
"upper": "<string>",
"unit": "<string>",
"choices": [
"<string>"
],
"accepted": [
"<string>"
]
}
],
"samples": [
{
"sample": 123,
"serial": "<string>",
"values": {},
"failed": [
"<string>"
]
}
],
"files": [
{
"characteristic": "<string>",
"name": "<string>",
"passed": true,
"uploaded_at": "<string>"
}
],
"defectives": 123,
"note": "<string>",
"recorded_by": "<string>",
"reinspects": {
"id": "<string>",
"number": "<string>",
"status": "<string>"
},
"superseded_by": {
"id": "<string>",
"number": "<string>",
"status": "<string>"
},
"reinspectable": true
}
}{
"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>"
]
}
]
}Inspections
Téléverser la photo ou le document qu'une caractéristique d'une inspection ouverte demande
{inspection} est l’ID de l’inspection et {characteristic} est la clé
d’une caractéristique photo ou document. Envoyez le fichier en
multipart/form-data. Un second téléversement pour la même caractéristique
remplace le premier. Répond avec l’inspection et le statut 201. Nécessite
l’autorisation quality.inspections.record, un jeton avec quality:write
et un forfait avec inspections de qualité.
POST
/
quality
/
inspections
/
{inspection}
/
files
/
{characteristic}
cURL
curl --request POST \
--url https://app.stockshift.io/api/v1/quality/inspections/{inspection}/files/{characteristic} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: multipart/form-data' \
--form file=@example-fileimport requests
url = "https://app.stockshift.io/api/v1/quality/inspections/{inspection}/files/{characteristic}"
files = { "file": ("example-file", open("example-file", "rb")) }
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, files=files, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.stockshift.io/api/v1/quality/inspections/{inspection}/files/{characteristic}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: multipart/form-data; boundary=---011000010111000001101001"
],
]);
$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/inspections/{inspection}/files/{characteristic}"
payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "multipart/form-data; boundary=---011000010111000001101001")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"data": {
"id": "<string>",
"number": "<string>",
"status": "<string>",
"point": "<string>",
"plan_name": "<string>",
"first_article": true,
"item_id": "<string>",
"item_sku": "<string>",
"item_name": "<string>",
"source_type": "<string>",
"source_id": "<string>",
"source_number": "<string>",
"source_detail": "<string>",
"lot": "<string>",
"serials": [
"<string>"
],
"quantity": "<string>",
"unit": "<string>",
"sample_size": 123,
"created_at": "<string>",
"recorded_at": "<string>",
"plan_id": "<string>",
"location_id": "<string>",
"location_code": "<string>",
"supplier_id": "<string>",
"supplier_name": "<string>",
"work_center_id": "<string>",
"work_center_name": "<string>",
"revision": "<string>",
"holds_stock": true,
"lot_size": 123,
"accept": 123,
"sampling": "<string>",
"inspection_level": "<string>",
"aql": "<string>",
"instructions": "<string>",
"characteristics": [
{
"key": "<string>",
"name": "<string>",
"kind": "pass_fail",
"nominal": "<string>",
"lower": "<string>",
"upper": "<string>",
"unit": "<string>",
"choices": [
"<string>"
],
"accepted": [
"<string>"
]
}
],
"samples": [
{
"sample": 123,
"serial": "<string>",
"values": {},
"failed": [
"<string>"
]
}
],
"files": [
{
"characteristic": "<string>",
"name": "<string>",
"passed": true,
"uploaded_at": "<string>"
}
],
"defectives": 123,
"note": "<string>",
"recorded_by": "<string>",
"reinspects": {
"id": "<string>",
"number": "<string>",
"status": "<string>"
},
"superseded_by": {
"id": "<string>",
"number": "<string>",
"status": "<string>"
},
"reinspectable": true
}
}{
"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>"
]
}
]
}Autorisations
apiKeyoauth2
Pour vos propres scripts et vos intégrations de serveur à serveur. Créez une clé dans l'application sous Paramètres > Accès > Clés d'API et copiez-la à ce moment-là, car elle n'est affichée qu'une fois. Envoyez-la sous la forme Authorization: Bearer <key>. La clé agit en tant que le membre qui l'a créée, dans l'organisation où elle a été créée. Un appel exige l'autorisation du membre et l'une des portées de la clé, comme inventory:read ou sales:write. Une clé avec * a toutes les portées.
Paramètres de chemin
L'ID de l'inspection.
La clé d'une caractéristique photo ou document de l'inspection.
Corps
multipart/form-data
La photo ou le document pour une caractéristique d'une inspection ouverte, envoyé en multipart/form-data. Son type est lu à partir de son contenu, non de son nom.
Une image PNG, JPEG, WebP ou GIF, ou un document PDF, texte ou CSV, d'au plus 10 Mo. Le type est lu à partir du contenu, et non du nom.
Réponse
InspectionResource
Une inspection en détail : ce qu'elle couvre, les caractéristiques qu'elle vérifie, son échantillonnage et les résultats consignés jusqu'ici.
Show child attributes
Show child attributes
Cette page vous a-t-elle été utile ?