Saltar para o conteúdo
ShopentlyLearn

Obter · Stock — Inventário

Consulte os dados de «Inventário». O resultado depende dos parâmetros desta operação.

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

Autenticação
Bearer
Disponível a partir de
STANDARD
Permissões necessárias
inventory.stock:read

Exemplos de código

Exemplo de requisição

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

Exemplo de resposta 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"
  }
}

Como funciona

  • Os registos de stock distinguem a quantidade física on_hand, as reservas de pedidos, as reservas manuais e a quantidade disponível para venda.
  • Use o identificador e a versão de stock retornados; stocks de produtos e variantes são destinos separados.
  • Um sellable_limit de -1 significa ilimitado, enquanto 0 significa indisponibilidade para venda.
  • A disponibilidade ilimitada é representada por null em available.
  • Não interprete null como zero.
  • Ajustes de stock, limites de venda e reservas manuais usam operações e permissões separadas.

Parâmetros

Parâmetros do caminho

stock_idTextoObrigatório

Identificador do registo de stock.

minLength: 1maxLength: 256
Exemplo: "stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ"

Esta operação não aceita um corpo JSON.

Respostas

Resposta 200

dataStockDetailData Obrigatório

Conteúdo de uma resposta bem-sucedida.

Campos · data
activeBooleanoObrigatório

Indica se o recurso está ativo.

allocationsLista <AllocationData > Obrigatório

Quantidades atribuídas às localizações do armazém.

Campos · allocations
availableNúmero inteiro nullObrigatório

Quantidade disponível para venda; null representa uma quantidade ilimitada.

idTextoObrigatório

Identificador do recurso; preserve-o conforme retornado.

manual_reservedNúmero inteiroObrigatório

Quantidade reservada manualmente.

on_handNúmero inteiroObrigatório

Quantidade física em stock.

reservedNúmero inteiroObrigatório

Quantidade reservada por pedidos.

sellable_limitNúmero inteiroObrigatório

Limite de venda: -1 significa ilimitado e 0 desativa a disponibilidade para venda.

target_idTextoObrigatório

Identificador do produto ou variante afetado pela operação.

target_typeTextoObrigatório

Indica se a operação se refere a um produto ou a uma variante.

Restrições
enum
["product", "variant"]
total_reservedNúmero inteiroObrigatório

Quantidade total reservada.

updated_atTextoObrigatório

Momento da atualização mais recente.

format: "date-time"
versionNúmero inteiroObrigatório

Versão do recurso utilizada para controlo de concorrência.

warehouse_idTextoObrigatório

Identificador do armazém.

metaContextPageMeta ContextMeta PageMeta RequestMeta Obrigatório

Metadados da resposta.

Campos · meta

ContextPageMeta

localeTextoObrigatório

Idioma selecionado para esta requisição.

market_codeTextoObrigatório

Código do mercado retornado pelo endpoint de contexto.

market_idTextoObrigatório

Identificador do mercado retornado pelo endpoint de contexto.

paginationPagination Obrigatório

Metadados da paginação por cursor.

request_idTextoObrigatório

Identificador da solicitação; nos metadados da resposta identifica a requisição HTTP.

minLength: 1maxLength: 100

ContextMeta

localeTextoObrigatório

Idioma selecionado para esta requisição.

market_codeTextoObrigatório

Código do mercado retornado pelo endpoint de contexto.

market_idTextoObrigatório

Identificador do mercado retornado pelo endpoint de contexto.

request_idTextoObrigatório

Identificador da solicitação; nos metadados da resposta identifica a requisição HTTP.

minLength: 1maxLength: 100

PageMeta

paginationPagination Obrigatório

Metadados da paginação por cursor.

request_idTextoObrigatório

Identificador da solicitação; nos metadados da resposta identifica a requisição HTTP.

minLength: 1maxLength: 100

RequestMeta

request_idTextoObrigatório

Identificador da solicitação; nos metadados da resposta identifica a requisição HTTP.

minLength: 1maxLength: 100
Exemplo de resposta

Estado HTTP

200
Resposta bem-sucedida Esquema
400
Pedido inválido
401
Autenticação necessária
403
Permissão negada
404
Recurso não encontrado
409
Conflito de versão
422
Falha na validação
429
Limite de pedidos excedido
Outros estados HTTP (7)
405
Método não permitido
413
Pedido demasiado grande
415
Formato não suportado
500
Erro do servidor
502
Erro do gateway da API
503
Serviço indisponível
504
Tempo de espera excedido

Catálogo de erros: ErrorResponse

Cabeçalhos

401

WWW-AuthenticateTextoOpcional

Esquema de autenticação exigido pelo servidor.

405

AllowTextoOpcional

Métodos HTTP aceitos por este recurso.

429, 503

Retry-AfterNúmero inteiroOpcional

Espera mínima antes de tentar novamente, em segundos.

minimum: 0