Pređi na sadržaj
ShopentlyLearn

Preuzmi · Zalihe — Zalihe

Pročitajte podatke iz „Zalihe“. Rezultat zavisi od parametara ove radnje.

GET/api/v1/inventory/stock/{stock_id}

Autentifikacija
Bearer
Dostupno od
STANDARD
Potrebna ovlašćenja
inventory.stock:read

Primeri koda

Primer zahteva

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))

Primer odgovora 200

JSON
{
  "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"
  }
}

Kako funkcioniše

  • Zapisi zaliha razlikuju fizičku količinu on_hand, rezervacije porudžbina, ručne rezervacije i količinu dostupnu za prodaju.
  • Koristite vraćeni identifikator i verziju zapisa zalihe; zalihe proizvoda i varijante posebni su ciljevi.
  • Vrednost sellable_limit -1 znači neograničeno, a 0 znači da prodaja nije dostupna.
  • Neograničena dostupnost prikazuje se kao null u available.
  • Ne smatrajte null nulom.
  • Prilagođavanja zaliha, ograničenja prodaje i ručne rezervacije koriste posebne operacije i ovlašćenja.

Parametri

Parametri putanje

stock_idNiz znakovaObavezno

Identifikator zapisa zalihe.

minLength: 1maxLength: 256
Primer: "stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ"

Ova operacija ne prihvata JSON telo.

Odgovori

Odgovor 200

dataStockDetailData Obavezno

Podaci uspešnog odgovora.

Polja · data
activeLogička vrednostObavezno

Da li je resurs aktivan.

allocationsNiz vrednosti <AllocationData > Obavezno

Količine dodeljene skladišnim lokacijama.

Polja · allocations
availableCeli broj nullObavezno

Količina dostupna za prodaju; null označava neograničenu količinu.

idNiz znakovaObavezno

Identifikator resursa; sačuvajte ga u vraćenom obliku.

manual_reservedCeli brojObavezno

Ručno rezervisana količina.

on_handCeli brojObavezno

Fizička količina na zalihi.

reservedCeli brojObavezno

Količina rezervisana porudžbinama.

sellable_limitCeli brojObavezno

Ograničenje prodaje: -1 znači neograničeno, a 0 onemogućuje dostupnu prodaju.

target_idNiz znakovaObavezno

Identifikator proizvoda ili varijante na koju operacija utiče.

target_typeNiz znakovaObavezno

Da li se odnosi operacija na proizvod ili varijantu.

Ograničenja
enum
["product", "variant"]
total_reservedCeli brojObavezno

Ukupno rezervisana količina.

updated_atNiz znakovaObavezno

Vreme poslednjeg ažuriranja.

format: "date-time"
versionCeli brojObavezno

Verzija resursa za kontrolu istovremenih upisa.

warehouse_idNiz znakovaObavezno

Identifikator skladišta.

metaContextPageMeta ContextMeta PageMeta RequestMeta Obavezno

Metapodaci odgovora.

Polja · meta

ContextPageMeta

localeNiz znakovaObavezno

Jezik odabran za ovaj zahtev.

market_codeNiz znakovaObavezno

Kod tržišta vraćen s krajnje tačke konteksta.

market_idNiz znakovaObavezno

Identifikator tržišta vraćen s krajnje tačke konteksta.

paginationPagination Obavezno

Metapodaci paginacije pomoću kursora.

request_idNiz znakovaObavezno

Identifikator zahteva; u metapodacima odgovora označava HTTP zahtev.

minLength: 1maxLength: 100

ContextMeta

localeNiz znakovaObavezno

Jezik odabran za ovaj zahtev.

market_codeNiz znakovaObavezno

Kod tržišta vraćen s krajnje tačke konteksta.

market_idNiz znakovaObavezno

Identifikator tržišta vraćen s krajnje tačke konteksta.

request_idNiz znakovaObavezno

Identifikator zahteva; u metapodacima odgovora označava HTTP zahtev.

minLength: 1maxLength: 100

PageMeta

paginationPagination Obavezno

Metapodaci paginacije pomoću kursora.

request_idNiz znakovaObavezno

Identifikator zahteva; u metapodacima odgovora označava HTTP zahtev.

minLength: 1maxLength: 100

RequestMeta

request_idNiz znakovaObavezno

Identifikator zahteva; u metapodacima odgovora označava HTTP zahtev.

minLength: 1maxLength: 100
Primer odgovora

HTTP status

200
Uspešan odgovor Šema
400
Nevažeći zahtev
401
Potrebna je autentifikacija
403
Pristup odbijen
404
Resurs nije pronađen
409
Sukob verzija
422
Provera nije uspela
429
Prekoračeno ograničenje zahteva
Ostali HTTP statusi (7)
405
Metoda nije dozvoljena
413
Zahtev je prevelik
415
Nepodržan format
500
Greška servera
502
Greška API mrežnog prolaza
503
Usluga nije dostupna
504
Istek vremena

Katalog grešaka: ErrorResponse

Zaglavlja

401

WWW-AuthenticateNiz znakovaOpciono

Šema autentifikacije koju zahteva server.

405

AllowNiz znakovaOpciono

HTTP metode koje ovaj resurs podržava.

429, 503

Retry-AfterCeli brojOpciono

Najkraće čekanje pre ponavljanja, u sekundama.

minimum: 0