Treci la conținut
ShopentlyLearn

Listează — Aprovizionări

Citiți datele din „Aprovizionări”. Rezultatul depinde de parametrii acestei operațiuni.

GET/api/v1/inventory/deliveries

Autentificare
Bearer
Disponibil începând cu
STANDARD
Permisiuni necesare
inventory.stock_delivery:read

Exemple de cod

Exemplu de cerere

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/deliveries?limit=20'

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/deliveries?limit=20');
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/deliveries?limit=20', 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))

Exemplu de răspuns 200

JSON
{
  "data": [
    {
      "created_at": "2026-01-01T12:00:00Z",
      "deleted_at": null,
      "delivered_at": "2026-01-01T12:00:00Z",
      "id": "example",
      "increases_stock": true,
      "location_id": "example",
      "quantity": 1,
      "received_at": null,
      "record_status": "active",
      "status": "planned",
      "stock_applied_at": null,
      "target_id": "example",
      "target_type": "product",
      "updated_at": "2026-01-01T12:00:00Z",
      "version": 1,
      "warehouse_id": "example"
    }
  ],
  "meta": {
    "pagination": {
      "has_more": false,
      "limit": 20,
      "next_cursor": null
    },
    "request_id": "example"
  }
}

Cum funcționează

  • O aprovizionare identifică un produs sau o variantă, depozitul, locația, cantitatea, data și starea.
  • Selectați explicit planned sau received și setați increases_stock în funcție de efectul dorit asupra stocului.
  • Crearea unei aprovizionări recepționate poate modifica stocul, deci trebuie acordată și permisiunea condițională necesară asupra stocurilor.
  • Reîncercați aceeași aprovizionare logică folosind cheia de idempotență originală, pentru a evita înregistrarea dublă.
  • Citiți stock_applied_at și stocul curent când verificați rezultatul.

Parametri

Parametri de interogare

limitNumăr întregOpțional

Numărul maxim de înregistrări pe această pagină.

minimum: 1maximum: 100
Valoare implicită: 50Exemplu: 20
cursorȘir de caractere nullOpțional

Valoare opacă de continuare returnată de pagina anterioară.

Șir de caractere:minLength: 1maxLength: 1024
warehouse_idȘir de caractere nullOpțional

Identificatorul depozitului.

Restricții · Șir de caractere 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
target_typeȘir de caractere nullOpțional

Indică dacă operația vizează un produs sau o variantă.

Restricții · Șir de caractere 1
enum
["product", "variant"]
target_idȘir de caractere nullOpțional

Identificatorul produsului sau al variantei vizate de operație.

Restricții · Șir de caractere 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
statusȘir de caractere nullOpțional

Starea acceptată de această operație specifică.

Restricții · Șir de caractere 1
enum
["planned", "received"]
record_statusȘir de caractere nullOpțional

Starea înregistrării salvate.

Restricții · Șir de caractere 1
enum
["active", "deleted"]

Această operație nu acceptă un corp JSON.

Răspunsuri

Răspuns 200

dataTablou <DeliveryData > Obligatoriu

Datele unui răspuns reușit.

Câmpuri · data

DeliveryData

created_atȘir de caractereObligatoriu

Momentul creării.

format: "date-time"
deleted_atȘir de caractere nullObligatoriu

Momentul ștergerii, dacă există.

Șir de caractere:format: "date-time"
delivered_atȘir de caractereObligatoriu

Data și ora livrării.

format: "date-time"
idȘir de caractereObligatoriu

Identificatorul resursei; păstrați-l în forma returnată.

increases_stockValoare booleanăObligatoriu

Indică dacă recepția aprovizionării mărește stocul.

location_idȘir de caractereObligatoriu

Identificatorul locației din depozit.

quantityNumăr întregObligatoriu

Numărul de unități.

received_atȘir de caractere nullObligatoriu

Data și ora recepției aprovizionării.

Șir de caractere:format: "date-time"
record_statusȘir de caractereObligatoriu

Starea înregistrării salvate.

Restricții
enum
["active", "deleted"]
statusȘir de caractereObligatoriu

Starea acceptată de această operație specifică.

Restricții
enum
["planned", "received"]
stock_applied_atȘir de caractere nullObligatoriu

Data și ora aplicării modificării de stoc aferente aprovizionării.

Șir de caractere:format: "date-time"
target_idȘir de caractereObligatoriu

Identificatorul produsului sau al variantei vizate de operație.

target_typeȘir de caractereObligatoriu

Indică dacă operația vizează un produs sau o variantă.

Restricții
enum
["product", "variant"]
updated_atȘir de caractere nullObligatoriu

Momentul celei mai recente actualizări.

Șir de caractere:format: "date-time"
versionNumăr întregObligatoriu

Versiunea resursei folosită pentru controlul concurenței.

warehouse_idȘir de caractereObligatoriu

Identificatorul depozitului.

metaContextPageMeta ContextMeta PageMeta RequestMeta Obligatoriu

Metadatele răspunsului.

Câmpuri · meta

ContextPageMeta

localeȘir de caractereObligatoriu

Limba selectată pentru această cerere.

market_codeȘir de caractereObligatoriu

Codul pieței returnat de endpointul de context.

market_idȘir de caractereObligatoriu

Identificatorul pieței returnat de endpointul de context.

paginationPagination Obligatoriu

Metadatele paginării prin cursor.

request_idȘir de caractereObligatoriu

Identificatorul solicitării; în metadatele răspunsului identifică cererea HTTP.

minLength: 1maxLength: 100

ContextMeta

localeȘir de caractereObligatoriu

Limba selectată pentru această cerere.

market_codeȘir de caractereObligatoriu

Codul pieței returnat de endpointul de context.

market_idȘir de caractereObligatoriu

Identificatorul pieței returnat de endpointul de context.

request_idȘir de caractereObligatoriu

Identificatorul solicitării; în metadatele răspunsului identifică cererea HTTP.

minLength: 1maxLength: 100

PageMeta

paginationPagination Obligatoriu

Metadatele paginării prin cursor.

request_idȘir de caractereObligatoriu

Identificatorul solicitării; în metadatele răspunsului identifică cererea HTTP.

minLength: 1maxLength: 100

RequestMeta

request_idȘir de caractereObligatoriu

Identificatorul solicitării; în metadatele răspunsului identifică cererea HTTP.

minLength: 1maxLength: 100
Exemplu de răspuns

Stare HTTP

200
Răspuns reușit Schemă
400
Cerere nevalidă
401
Autentificare necesară
403
Acces refuzat
404
Resursa nu a fost găsită
409
Conflict de versiune
422
Validare eșuată
429
Limită de cereri depășită
Alte stări HTTP (7)
405
Metodă nepermisă
413
Cerere prea mare
415
Format neacceptat
500
Eroare de server
502
Eroare de gateway API
503
Serviciu indisponibil
504
Timp de așteptare depășit

Catalog de erori: ErrorResponse

Antete

401

WWW-AuthenticateȘir de caractereOpțional

Schema de autentificare cerută de server.

405

AllowȘir de caractereOpțional

Metodele HTTP acceptate de această resursă.

429, 503

Retry-AfterNumăr întregOpțional

Întârzierea minimă înainte de reîncercare, în secunde.

minimum: 0