cURL
curl --request POST \
--url https://app.stockshift.io/api/v1/sync/commands \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"commands": [
{
"id": "0199a0d0-0000-7000-8000-00000000f001",
"name": "inventory.counts.add_line",
"depends_on": [],
"created_at": "2026-11-02T10:00:00+00:00",
"payload": {
"count_id": "0199a0d0-0000-7000-8000-00000000f002",
"item": "0199a0d0-0000-7000-8000-00000000f003",
"quantity": "40"
}
}
]
}
'import requests
url = "https://app.stockshift.io/api/v1/sync/commands"
payload = { "commands": [
{
"id": "0199a0d0-0000-7000-8000-00000000f001",
"name": "inventory.counts.add_line",
"depends_on": [],
"created_at": "2026-11-02T10:00:00+00:00",
"payload": {
"count_id": "0199a0d0-0000-7000-8000-00000000f002",
"item": "0199a0d0-0000-7000-8000-00000000f003",
"quantity": "40"
}
}
] }
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/sync/commands",
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([
'commands' => [
[
'id' => '0199a0d0-0000-7000-8000-00000000f001',
'name' => 'inventory.counts.add_line',
'depends_on' => [
],
'created_at' => '2026-11-02T10:00:00+00:00',
'payload' => [
'count_id' => '0199a0d0-0000-7000-8000-00000000f002',
'item' => '0199a0d0-0000-7000-8000-00000000f003',
'quantity' => '40'
]
]
]
]),
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/sync/commands"
payload := strings.NewReader("{\n \"commands\": [\n {\n \"id\": \"0199a0d0-0000-7000-8000-00000000f001\",\n \"name\": \"inventory.counts.add_line\",\n \"depends_on\": [],\n \"created_at\": \"2026-11-02T10:00:00+00:00\",\n \"payload\": {\n \"count_id\": \"0199a0d0-0000-7000-8000-00000000f002\",\n \"item\": \"0199a0d0-0000-7000-8000-00000000f003\",\n \"quantity\": \"40\"\n }\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": {
"results": [
{
"id": "<string>",
"status": "applied",
"replayed": true,
"result": "<unknown>",
"result_ids": [
"<string>"
],
"code": "<string>",
"message": "<string>",
"fields": {},
"retry_after": 123
}
]
}
}{
"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>"
]
}
]
}Sync commands
Send offline commands
Applies up to 100 commands (1 MB at most) as the member, in order, each
exactly as the same change made in the app. Every command answers with
applied, rejected or deferred. applied comes with the result.
rejected is final and comes with a code, a message and the
invalid fields. deferred means not run: a dependency is unfinished
in another batch or the batch used its 20 second budget, so send it
again after retry_after seconds. A command
sent again returns its stored result with replayed: true and runs
nothing; the same id with another payload is rejected
command_id_reused. A command whose dependency was rejected is
rejected dependency_rejected. Needs a token of a registered device
with sync:write, and each command needs its own permission, plan
feature and scope when it is applied.
POST
/
sync
/
commands
cURL
curl --request POST \
--url https://app.stockshift.io/api/v1/sync/commands \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"commands": [
{
"id": "0199a0d0-0000-7000-8000-00000000f001",
"name": "inventory.counts.add_line",
"depends_on": [],
"created_at": "2026-11-02T10:00:00+00:00",
"payload": {
"count_id": "0199a0d0-0000-7000-8000-00000000f002",
"item": "0199a0d0-0000-7000-8000-00000000f003",
"quantity": "40"
}
}
]
}
'import requests
url = "https://app.stockshift.io/api/v1/sync/commands"
payload = { "commands": [
{
"id": "0199a0d0-0000-7000-8000-00000000f001",
"name": "inventory.counts.add_line",
"depends_on": [],
"created_at": "2026-11-02T10:00:00+00:00",
"payload": {
"count_id": "0199a0d0-0000-7000-8000-00000000f002",
"item": "0199a0d0-0000-7000-8000-00000000f003",
"quantity": "40"
}
}
] }
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/sync/commands",
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([
'commands' => [
[
'id' => '0199a0d0-0000-7000-8000-00000000f001',
'name' => 'inventory.counts.add_line',
'depends_on' => [
],
'created_at' => '2026-11-02T10:00:00+00:00',
'payload' => [
'count_id' => '0199a0d0-0000-7000-8000-00000000f002',
'item' => '0199a0d0-0000-7000-8000-00000000f003',
'quantity' => '40'
]
]
]
]),
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/sync/commands"
payload := strings.NewReader("{\n \"commands\": [\n {\n \"id\": \"0199a0d0-0000-7000-8000-00000000f001\",\n \"name\": \"inventory.counts.add_line\",\n \"depends_on\": [],\n \"created_at\": \"2026-11-02T10:00:00+00:00\",\n \"payload\": {\n \"count_id\": \"0199a0d0-0000-7000-8000-00000000f002\",\n \"item\": \"0199a0d0-0000-7000-8000-00000000f003\",\n \"quantity\": \"40\"\n }\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": {
"results": [
{
"id": "<string>",
"status": "applied",
"replayed": true,
"result": "<unknown>",
"result_ids": [
"<string>"
],
"code": "<string>",
"message": "<string>",
"fields": {},
"retry_after": 123
}
]
}
}{
"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 batch of commands.
commands
(SyncCommandInventoryCountsAddLine · object | SyncCommandInventoryCountsRecord · object | SyncCommandInventoryReleaseRequestsCreate · object | SyncCommandInventoryStockAdjust · object | SyncCommandInventoryStockChangeStatus · object | SyncCommandInventoryStockMove · object | SyncCommandInventoryStockReverse · object | SyncCommandInventoryStockReverseMove · object | SyncCommandInventoryTransfersCreate · object | SyncCommandInventoryTransfersReceive · object | SyncCommandInventoryTransfersShip · object | SyncCommandInventoryVerificationsCancel · object | SyncCommandInventoryVerificationsCount · object | SyncCommandInventoryVerificationsDecline · object | SyncCommandInventoryVerificationsReject · object | SyncCommandInventoryVerificationsRequest · object | SyncCommandInventoryVerificationsSubmit · object | SyncCommandInventoryVerificationsWitness · object | SyncCommandLabelsSetsPrint · object | SyncCommandManufacturingBuildsComplete · object | SyncCommandManufacturingBuildsIssueParts · object | SyncCommandManufacturingBuildsReportProblem · object | SyncCommandManufacturingOperationsComplete · object | SyncCommandManufacturingOperationsPause · object | SyncCommandManufacturingOperationsStart · object | SyncCommandPurchasingOrdersReceive · object | SyncCommandSalesOrdersShip · object)[]
required
The commands, 1 to 100 and 1 MB in all. They run in this order.
Required array length:
1 - 100 elementsThe inventory.counts.add_line command.
- SyncCommandInventoryCountsAddLine
- SyncCommandInventoryCountsRecord
- SyncCommandInventoryReleaseRequestsCreate
- SyncCommandInventoryStockAdjust
- SyncCommandInventoryStockChangeStatus
- SyncCommandInventoryStockMove
- SyncCommandInventoryStockReverse
- SyncCommandInventoryStockReverseMove
- SyncCommandInventoryTransfersCreate
- SyncCommandInventoryTransfersReceive
- SyncCommandInventoryTransfersShip
- SyncCommandInventoryVerificationsCancel
- SyncCommandInventoryVerificationsCount
- SyncCommandInventoryVerificationsDecline
- SyncCommandInventoryVerificationsReject
- SyncCommandInventoryVerificationsRequest
- SyncCommandInventoryVerificationsSubmit
- SyncCommandInventoryVerificationsWitness
- SyncCommandLabelsSetsPrint
- SyncCommandManufacturingBuildsComplete
- SyncCommandManufacturingBuildsIssueParts
- SyncCommandManufacturingBuildsReportProblem
- SyncCommandManufacturingOperationsComplete
- SyncCommandManufacturingOperationsPause
- SyncCommandManufacturingOperationsStart
- SyncCommandPurchasingOrdersReceive
- SyncCommandSalesOrdersShip
Show child attributes
Show child attributes
Example:
{
"id": "0199a0d0-0000-7000-8000-00000000f001",
"name": "inventory.counts.add_line",
"depends_on": [],
"created_at": "2026-11-02T10:00:00+00:00",
"payload": {
"count_id": "0199a0d0-0000-7000-8000-00000000f002",
"item": "0199a0d0-0000-7000-8000-00000000f003",
"quantity": "40"
}
}
Response
CommandResultsResource
Show child attributes
Show child attributes
Was this page helpful?