Getir · Stok — Stok
“Stok” verilerini okuyun. Sonuç, bu işlemin parametrelerine bağlıdır.
GET/api/v1/inventory/stock/{stock_id}
- Kimlik doğrulama
Bearer- En düşük plan
- STANDARD
- Gerekli izinler
inventory.stock:read
Kod örnekleri
İstek örneği
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))
Yanıt örneği 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"
}
}
Nasıl çalışır
- Stok kayıtlarında fiziksel on_hand miktarı, sipariş rezervasyonları, manuel rezervasyonlar ve satışa sunulabilecek miktar ayrıdır.
- Döndürülen stok tanımlayıcısını ve sürümünü kullanın; ürün ve varyant stokları ayrı hedeflerdir.
- sellable_limit için -1 sınırsız, 0 ise satışa açık miktar olmadığı anlamına gelir.
- Sınırsız kullanılabilirlik, available alanında null olarak gösterilir.
- null değerini sıfır olarak değerlendirmeyin.
- Stok düzeltmeleri, satış sınırları ve manuel rezervasyonlar ayrı işlemler ve izinler kullanır.
Parametreler
Yol parametreleri
stock_idDizeZorunluStok kaydı tanımlayıcısı.
minLength:1maxLength:256
Bu işlem JSON gövdesi kabul etmez.
Yanıtlar
Yanıt 200
Tam model: ApiResponse_StockDetailData_
dataStockDetailDataZorunluBaşarılı yanıtın verileri.
Alanlar ·
dataactiveMantıksal değerZorunluKaynağın etkin olup olmadığı.
allocationsDizi <AllocationData> ZorunluDepo konumlarına atanan miktarlar.
Alanlar ·
allocationsavailableTam sayı nullZorunluSatışa sunulabilir miktar; null sınırsız miktarı belirtir.
idDizeZorunluKaynak tanımlayıcısı; döndürüldüğü biçimi koruyun.
manual_reservedTam sayıZorunluElle ayrılan miktar.
on_handTam sayıZorunluFiziksel stok miktarı.
reservedTam sayıZorunluSiparişler tarafından ayrılan miktar.
sellable_limitTam sayıZorunluSatış sınırı: -1 sınırsız anlamına gelir, 0 ise mevcut satışları kapatır.
target_idDizeZorunluİşlemin etkilediği ürün veya varyantın tanımlayıcısı.
target_typeDizeZorunluİşlemin ürünle mi, varyantla mı ilgili olduğu.
Kısıtlamalar
enum["product", "variant"]
total_reservedTam sayıZorunluAyrılan toplam miktar.
updated_atDizeZorunluSon güncelleme zamanı.
format:"date-time"versionTam sayıZorunluEşzamanlılık denetiminde kullanılan kaynak sürümü.
warehouse_idDizeZorunluDepo tanımlayıcısı.
metaContextPageMetaContextMetaPageMetaRequestMetaZorunluYanıt üst verileri.
Alanlar ·
metalocaleDizeZorunluBu istek için seçilen dil.
market_codeDizeZorunluBağlam uç noktasının döndürdüğü pazar kodu.
market_idDizeZorunluBağlam uç noktasının döndürdüğü pazar tanımlayıcısı.
paginationPaginationZorunluİmleç tabanlı sayfalamanın üst verileri.
request_idDizeZorunluTalep tanımlayıcısı; yanıt üst verilerinde HTTP isteğini tanımlar.
minLength:1maxLength:100
localeDizeZorunluBu istek için seçilen dil.
market_codeDizeZorunluBağlam uç noktasının döndürdüğü pazar kodu.
market_idDizeZorunluBağlam uç noktasının döndürdüğü pazar tanımlayıcısı.
request_idDizeZorunluTalep tanımlayıcısı; yanıt üst verilerinde HTTP isteğini tanımlar.
minLength:1maxLength:100
paginationPaginationZorunluİmleç tabanlı sayfalamanın üst verileri.
request_idDizeZorunluTalep tanımlayıcısı; yanıt üst verilerinde HTTP isteğini tanımlar.
minLength:1maxLength:100
request_idDizeZorunluTalep tanımlayıcısı; yanıt üst verilerinde HTTP isteğini tanımlar.
minLength:1maxLength:100
HTTP durumu
200- Başarılı yanıt Şema
400- Geçersiz istek
401- Kimlik doğrulaması gerekli
403- İzin reddedildi
404- Kaynak bulunamadı
409- Sürüm çakışması
422- Doğrulama başarısız
429- İstek sınırı aşıldı
Diğer HTTP durumları (7)
405- Yönteme izin verilmiyor
413- İstek çok büyük
415- Desteklenmeyen biçim
500- Sunucu hatası
502- API ağ geçidi hatası
503- Hizmet kullanılamıyor
504- Zaman aşımı
Hata kataloğu: ErrorResponse
Başlıklar
401
WWW-AuthenticateDizeİsteğe bağlıSunucunun gerektirdiği kimlik doğrulama şeması.
405
AllowDizeİsteğe bağlıBu kaynağın desteklediği HTTP yöntemleri.
429, 503
Retry-AfterTam sayıİsteğe bağlıYeniden denemeden önce saniye cinsinden en kısa bekleme süresi.
minimum:0