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>"
]
}
]
}Commandes de synchronisation
Envoyer des commandes hors ligne
Applique jusqu’à 100 commandes (1 Mo au plus en tout) en tant que membre, dans l’ordre
d’envoi. Chacune est appliquée exactement comme la même modification faite dans
l’application. Chaque commande répond applied, rejected ou deferred. applied
vient avec le résultat. rejected est définitif et vient avec un code, un
message et les fields invalides. deferred signifie que la commande n’a pas été
exécutée : une dépendance n’est pas terminée dans un autre lot, la même commande
s’exécute dans une autre requête, ou le lot a épuisé son budget de 20 secondes. Renvoyez une
commande différée après retry_after secondes.
Une commande renvoyée retourne son résultat enregistré avec replayed: true et
n’exécute rien. Le même id avec une autre charge utile est rejeté avec
command_id_reused. Une commande dont la dépendance a été rejetée est rejetée
avec dependency_rejected. Une commande créée il y a plus de 90 jours est
rejetée avec command_expired, et une commande que le serveur ne connaît pas avec
unknown_command.
Nécessite un jeton d’un appareil enregistré avec sync:write, et chaque commande
exige sa propre autorisation, sa propre fonctionnalité de forfait et sa propre portée lorsqu’elle est appliquée.
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>"
]
}
]
}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.
Corps
application/json
Un lot de commandes qu'un appareil envoie, dans l'ordre où elles s'exécutent.
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)[]
requis
Les commandes, de 1 à 100 et 1 Mo au total. Elles s'exécutent dans cet ordre.
Required array length:
1 - 100 elementsStock trouvé que le dénombrement n'attendait pas : un article, son lot, la quantité comptée et, si le compteur l'indique, quand et après quel contact.
- 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
Exemple:
{
"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"
}
}
Réponse
CommandResultsResource
Ce qu'est devenue chaque commande d'un lot, dans l'ordre d'envoi.
Show child attributes
Show child attributes
Cette page vous a-t-elle été utile ?