cURL
curl --request POST \
--url https://app.stockshift.io/api/v1/inventory/bulk-previews \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"lines": [
{
"item": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"quantity": "<string>",
"location_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"lot": "<string>",
"serial": "<string>",
"piece": "<string>"
}
]
}
'import requests
url = "https://app.stockshift.io/api/v1/inventory/bulk-previews"
payload = { "lines": [
{
"item": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"quantity": "<string>",
"location_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"lot": "<string>",
"serial": "<string>",
"piece": "<string>"
}
] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.stockshift.io/api/v1/inventory/bulk-previews",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'lines' => [
[
'item' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'quantity' => '<string>',
'location_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'lot' => '<string>',
'serial' => '<string>',
'piece' => '<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/inventory/bulk-previews"
payload := strings.NewReader("{\n \"lines\": [\n {\n \"item\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"quantity\": \"<string>\",\n \"location_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"lot\": \"<string>\",\n \"serial\": \"<string>\",\n \"piece\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", 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": {
"action": "move",
"destination_id": "<string>",
"lines": [
{
"line": 123,
"item": "<string>",
"location_id": "<string>",
"lot": "<string>",
"serial": "<string>",
"piece": "<string>",
"quantity": "<string>",
"flags": [
{
"flag": "blocked",
"facts": {
"reason": "<string>",
"status": "<string>",
"held": "<string>",
"expires_on": "<string>",
"days_left": 123,
"minimum_days": 123,
"reserved": "<string>",
"free": "<string>",
"lots": [
"<string>"
],
"merged_into": 123,
"permission": "<string>",
"entitlement": "<string>"
},
"choices": [
"leave"
]
}
]
}
]
}
}{
"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>"
]
}
]
}Bulk previews
Preview a bulk stock action
Check a list of up to 100 lines before you move, adjust, hold or print them, one command per line.
Each line comes back with its flags. blocked means held, expired, under a witness policy or a lot
the destination refuses. reserved means documents hold some of it. mixed_lots means the
destination holds another lot. short_dated means the lot expires sooner than the destination’s
rule allows. duplicate means merged into another line. The last flag is not_permitted. Each flag has its facts and the choices
it allows; a flag without choices takes the line out. Send the choices made as the line command’s
decisions, with the same bulk_id on every line: a flag left undecided is refused with
decision_required when the command is applied.
Quantities are in the item’s base unit. An adjustment’s lines are negative to take stock out. Nothing is changed.
Needs the inventory.stock.view permission and a token with inventory:read. From a device, the plan
needs mobile operations.
POST
/
inventory
/
bulk-previews
cURL
curl --request POST \
--url https://app.stockshift.io/api/v1/inventory/bulk-previews \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"lines": [
{
"item": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"quantity": "<string>",
"location_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"lot": "<string>",
"serial": "<string>",
"piece": "<string>"
}
]
}
'import requests
url = "https://app.stockshift.io/api/v1/inventory/bulk-previews"
payload = { "lines": [
{
"item": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"quantity": "<string>",
"location_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"lot": "<string>",
"serial": "<string>",
"piece": "<string>"
}
] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.stockshift.io/api/v1/inventory/bulk-previews",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'lines' => [
[
'item' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'quantity' => '<string>',
'location_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'lot' => '<string>',
'serial' => '<string>',
'piece' => '<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/inventory/bulk-previews"
payload := strings.NewReader("{\n \"lines\": [\n {\n \"item\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"quantity\": \"<string>\",\n \"location_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"lot\": \"<string>\",\n \"serial\": \"<string>\",\n \"piece\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", 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": {
"action": "move",
"destination_id": "<string>",
"lines": [
{
"line": 123,
"item": "<string>",
"location_id": "<string>",
"lot": "<string>",
"serial": "<string>",
"piece": "<string>",
"quantity": "<string>",
"flags": [
{
"flag": "blocked",
"facts": {
"reason": "<string>",
"status": "<string>",
"held": "<string>",
"expires_on": "<string>",
"days_left": 123,
"minimum_days": 123,
"reserved": "<string>",
"free": "<string>",
"lots": [
"<string>"
],
"merged_into": 123,
"permission": "<string>",
"entitlement": "<string>"
},
"choices": [
"leave"
]
}
]
}
]
}
}{
"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.
Body
application/json
A bulk list to check: one action, a destination for a move only, a reason for an adjustment only and 1 to 100 lines. Quantities are in the item's base unit; an adjustment's lines may be negative, to take stock out.
What a bulk list does to every line. Each line is sent as its own command, so each needs that command's permission and the plan feature its Action asks for.
Available options:
move, adjust, hold, print Required array length:
1 - 100 elementsShow child attributes
Show child attributes
Available options:
found, damaged, lost, destroyed, correction, opening_balance, other, null Response
BulkPreviewResource
Show child attributes
Show child attributes
Was this page helpful?