Recupera · Giacenze — Scorte
Leggi i dati di «Scorte». Il risultato dipende dai parametri di questa operazione.
GET/api/v1/inventory/stock/{stock_id}
- Autenticazione
Bearer- Disponibile dal piano
- STANDARD
- Permessi necessari
inventory.stock:read
Esempi di codice
Esempio di richiesta
cURL
: "${SHOPENTLY_SHOP_URL:?}"
curl --disable --globoff --fail-with-body --silent --show-error \
--proto '=https' --connect-timeout 5 --max-time 30 \
--request GET \
--header "Authorization: Bearer ${SHOPENTLY_ACCESS_TOKEN:?}" \
--url "${SHOPENTLY_SHOP_URL%/}"/api/v1/inventory/stock/stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ
PHP
<?php
declare(strict_types=1);
$baseUrl = rtrim(getenv('SHOPENTLY_SHOP_URL') ?: '', '/');
$origin = parse_url($baseUrl);
if (!$origin || ($origin['scheme'] ?? '') !== 'https' || empty($origin['host']) ||
isset($origin['user'], $origin['pass']) || isset($origin['user']) || isset($origin['path']) ||
isset($origin['query']) || isset($origin['fragment'])) {
throw new RuntimeException('SHOPENTLY_SHOP_URL must be an HTTPS origin');
}
$credential = getenv('SHOPENTLY_ACCESS_TOKEN') ?: '';
if ($credential === '' || strpbrk($credential, "\r\n") !== false) {
throw new RuntimeException('Invalid credential');
}
$headers = [];
$headers[] = 'Authorization: Bearer ' . $credential;
$responseHeaders = [];
$handle = curl_init($baseUrl . '/api/v1/inventory/stock/stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ');
curl_setopt_array($handle, [
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => $headers,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_FOLLOWLOCATION => false,
CURLOPT_PROTOCOLS => CURLPROTO_HTTPS,
CURLOPT_SSL_VERIFYPEER => true,
CURLOPT_SSL_VERIFYHOST => 2,
CURLOPT_CONNECTTIMEOUT => 5,
CURLOPT_TIMEOUT => 30,
CURLOPT_HEADERFUNCTION => static function ($handle, string $line) use (&$responseHeaders): int {
if (str_contains($line, ':')) {
[$name, $value] = explode(':', $line, 2);
$responseHeaders[strtolower(trim($name))] = trim($value);
}
return strlen($line);
},
]);
$raw = curl_exec($handle);
$status = curl_getinfo($handle, CURLINFO_RESPONSE_CODE);
$error = curl_error($handle);
curl_close($handle);
if ($raw === false) {
throw new RuntimeException('Transport error: ' . $error);
}
if ($status < 200 || $status >= 300) {
throw new RuntimeException('HTTP ' . $status . '; request_id=' .
($responseHeaders['x-request-id'] ?? '') . '; retry_after=' . ($responseHeaders['retry-after'] ?? ''));
}
$result = $raw === '' ? null : json_decode($raw, true, 512, JSON_THROW_ON_ERROR | JSON_BIGINT_AS_STRING);
echo json_encode($result, JSON_THROW_ON_ERROR | JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE), PHP_EOL;
Python
from contextlib import ExitStack
import json
import os
from urllib.parse import urlsplit
import requests # python -m pip install requests
base_url = os.environ["SHOPENTLY_SHOP_URL"].rstrip("/")
origin = urlsplit(base_url)
if origin.scheme != "https" or not origin.hostname or origin.username or origin.password or origin.path or origin.query or origin.fragment:
raise ValueError("SHOPENTLY_SHOP_URL must be an HTTPS origin")
credential = os.environ['SHOPENTLY_ACCESS_TOKEN']
if not credential or "\r" in credential or "\n" in credential:
raise ValueError("Invalid credential")
headers = {}
headers["Authorization"] = 'Bearer' + " " + credential
body = None
if body is not None:
headers["Content-Type"] = "application/json"
with ExitStack() as stack:
session = stack.enter_context(requests.Session())
files = None
if False:
image = stack.enter_context(open(os.environ["SHOPENTLY_IMAGE_FILE"], "rb"))
if os.fstat(image.fileno()).st_size > 5242880:
raise ValueError("Image exceeds 5 MiB")
files = {"file": ("article.png", image, "image/png")}
response = session.request(
'GET', base_url + '/api/v1/inventory/stock/stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ', headers=headers,
data=body.encode("utf-8") if body is not None else None, files=files,
timeout=(5, 30), allow_redirects=False,
)
if not 200 <= response.status_code < 300:
raise RuntimeError(f"HTTP {response.status_code}; request_id={response.headers.get('X-Request-ID', '')}; retry_after={response.headers.get('Retry-After', '')}")
if False:
if response.headers.get("Content-Type") != "image/webp" or len(response.content) > 5242880:
raise ValueError("Unexpected image response")
with open(os.environ["SHOPENTLY_OUTPUT_FILE"], "xb") as output:
output.write(response.content)
else:
result = response.json() if response.content else None
print(json.dumps(result, ensure_ascii=False, indent=2))
Esempio di risposta 200
{
"data": {
"active": true,
"allocations": [
{
"location_code": "example",
"location_id": "example",
"location_name": "example",
"on_hand": 10
}
],
"available": 5,
"id": "stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ",
"manual_reserved": 2,
"on_hand": 10,
"reserved": 3,
"sellable_limit": 10,
"target_id": "example",
"target_type": "product",
"total_reserved": 5,
"updated_at": "2026-01-01T12:00:00Z",
"version": 1,
"warehouse_id": "example"
},
"meta": {
"request_id": "example"
}
}
Principi
- I record distinguono quantità fisica on_hand, prenotazioni degli ordini, prenotazioni manuali e quantità disponibile alla vendita.
- Usa identificativo e versione del record restituiti; scorte del prodotto e della variante sono destinazioni distinte.
- sellable_limit uguale a -1 indica assenza di limite, mentre 0 impedisce la disponibilità alla vendita.
- Una disponibilità illimitata viene esposta come null in available.
- Non interpretare null come zero.
- Rettifiche, limiti di vendita e prenotazioni manuali hanno operazioni e permessi separati.
Parametri
Parametri del percorso
stock_idStringaObbligatorioIdentificativo del record delle scorte.
minLength:1maxLength:256
Questa operazione non accetta un corpo JSON.
Risposte
Risposta 200
Modello completo: ApiResponse_StockDetailData_
dataStockDetailDataObbligatorioContenuto di una risposta riuscita.
Campi ·
dataModello completo:
StockDetailDataactiveBooleanoObbligatorioIndica se la risorsa è attiva.
allocationsArray <AllocationData> ObbligatorioQuantità assegnate alle ubicazioni del magazzino.
Campi ·
allocationsavailableIntero nullObbligatorioQuantità disponibile alla vendita; null indica una quantità illimitata.
idStringaObbligatorioIdentificativo della risorsa; conservalo come restituito.
manual_reservedInteroObbligatorioQuantità prenotata manualmente.
on_handInteroObbligatorioQuantità fisicamente presente.
reservedInteroObbligatorioQuantità prenotata dagli ordini.
sellable_limitInteroObbligatorioLimite di vendita: -1 indica assenza di limite e 0 disabilita la disponibilità alla vendita.
target_idStringaObbligatorioIdentificativo del prodotto o della variante interessati dall’operazione.
target_typeStringaObbligatorioIndica se l’operazione riguarda un prodotto o una variante.
Vincoli
enum["product", "variant"]
total_reservedInteroObbligatorioQuantità totale prenotata.
updated_atStringaObbligatorioData e ora dell’aggiornamento più recente.
format:"date-time"versionInteroObbligatorioVersione della risorsa per il controllo della concorrenza.
warehouse_idStringaObbligatorioIdentificativo del magazzino.
metaContextPageMetaContextMetaPageMetaRequestMetaObbligatorioMetadati della risposta.
Campi ·
metaModello completo:
ContextPageMetalocaleStringaObbligatorioLingua selezionata per questa richiesta.
market_codeStringaObbligatorioCodice del mercato restituito dall’endpoint del contesto.
market_idStringaObbligatorioIdentificativo del mercato restituito dall’endpoint del contesto.
paginationPaginationObbligatorioMetadati della paginazione a cursore.
request_idStringaObbligatorioIdentificativo della richiesta; nei metadati della risposta identifica la richiesta HTTP.
minLength:1maxLength:100
localeStringaObbligatorioLingua selezionata per questa richiesta.
market_codeStringaObbligatorioCodice del mercato restituito dall’endpoint del contesto.
market_idStringaObbligatorioIdentificativo del mercato restituito dall’endpoint del contesto.
request_idStringaObbligatorioIdentificativo della richiesta; nei metadati della risposta identifica la richiesta HTTP.
minLength:1maxLength:100
paginationPaginationObbligatorioMetadati della paginazione a cursore.
request_idStringaObbligatorioIdentificativo della richiesta; nei metadati della risposta identifica la richiesta HTTP.
minLength:1maxLength:100
request_idStringaObbligatorioIdentificativo della richiesta; nei metadati della risposta identifica la richiesta HTTP.
minLength:1maxLength:100
Stato HTTP
200- Risposta riuscita Schema
400- Richiesta non valida
401- Autenticazione richiesta
403- Permesso negato
404- Risorsa non trovata
409- Conflitto di versione
422- Validazione non riuscita
429- Limite di richieste superato
Altri stati HTTP (7)
405- Metodo non consentito
413- Richiesta troppo grande
415- Formato non supportato
500- Errore del server
502- Errore del gateway API
503- Servizio non disponibile
504- Tempo di attesa scaduto
Catalogo degli errori: ErrorResponse
Header
401
WWW-AuthenticateStringaFacoltativoSchema di autenticazione richiesto dal server.
405
AllowStringaFacoltativoMetodi HTTP supportati da questa risorsa.
429, 503
Retry-AfterInteroFacoltativoAttesa minima prima di riprovare, in secondi.
minimum:0