Mine sisu juurde
ShopentlyLearn

Loend — Tarned

Lugege andmeid ressursist „Tarned“. Tulemus sõltub toimingu parameetritest.

GET/api/v1/inventory/deliveries

Autentimine
Bearer
Saadaval alates
STANDARD
Nõutavad õigused
inventory.stock_delivery:read

Koodinäited

Päringu näide

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

Vastuse näide 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"
  }
}

Kuidas see toimib

  • Tarne määrab toote või variandi, lao, asukoha, koguse, kuupäeva ja oleku.
  • Vali selgesõnaliselt planned või received ning määra increases_stock soovitud laomõju järgi.
  • Vastuvõetud tarne loomine võib muuta laoseisu, mistõttu on vaja ka tingimuslikku laoõigust.
  • Sama tarne kordamisel kasuta algset idempotentsusvõtit, et seda mitte topelt registreerida.
  • Tulemuste kooskõlastamisel loe stock_applied_at ja kehtiv laoseis.

Parameetrid

Päringu parameetrid

limitTäisarvValikuline

Kirjete maksimaalne arv sellel lehel.

minimum: 1maximum: 100
Vaikeväärtus: 50Näide: 20
cursorString nullValikuline

Eelmisel lehel tagastatud läbipaistmatu jätkuväärtus.

String:minLength: 1maxLength: 1024
warehouse_idString nullValikuline

Lao identifikaator.

Piirangud · String 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
target_typeString nullValikuline

Kas toiming puudutab toodet või varianti.

Piirangud · String 1
enum
["product", "variant"]
target_idString nullValikuline

Toimingust mõjutatud toote või variandi identifikaator.

Piirangud · String 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
statusString nullValikuline

Selle konkreetse toimingu lubatud olek.

Piirangud · String 1
enum
["planned", "received"]
record_statusString nullValikuline

Salvestatud kirje olek.

Piirangud · String 1
enum
["active", "deleted"]

See toiming ei võta vastu JSON-sisu.

Vastused

Vastus 200

dataMassiiv <DeliveryData > Kohustuslik

Eduka vastuse andmed.

Väljad · data

DeliveryData

created_atStringKohustuslik

Loomise aeg.

format: "date-time"
deleted_atString nullKohustuslik

Kustutamise aeg, kui see on olemas.

String:format: "date-time"
delivered_atStringKohustuslik

Tarne kuupäev ja kellaaeg.

format: "date-time"
idStringKohustuslik

Ressursi identifikaator; säilita see tagastatud kujul.

increases_stockTõeväärtusKohustuslik

Kas tarne vastuvõtmine suurendab laoseisu.

location_idStringKohustuslik

Laoasukoha identifikaator.

quantityTäisarvKohustuslik

Ühikute arv.

received_atString nullKohustuslik

Tarne vastuvõtmise kuupäev ja kellaaeg.

String:format: "date-time"
record_statusStringKohustuslik

Salvestatud kirje olek.

Piirangud
enum
["active", "deleted"]
statusStringKohustuslik

Selle konkreetse toimingu lubatud olek.

Piirangud
enum
["planned", "received"]
stock_applied_atString nullKohustuslik

Tarne laomuutuse rakendamise kuupäev ja kellaaeg.

String:format: "date-time"
target_idStringKohustuslik

Toimingust mõjutatud toote või variandi identifikaator.

target_typeStringKohustuslik

Kas toiming puudutab toodet või varianti.

Piirangud
enum
["product", "variant"]
updated_atString nullKohustuslik

Viimase uuendamise aeg.

String:format: "date-time"
versionTäisarvKohustuslik

Ressursi versioon samaaegsuse kontrolliks.

warehouse_idStringKohustuslik

Lao identifikaator.

metaContextPageMeta ContextMeta PageMeta RequestMeta Kohustuslik

Vastuse metaandmed.

Väljad · meta

ContextPageMeta

localeStringKohustuslik

Selle päringu jaoks valitud keel.

market_codeStringKohustuslik

Konteksti lõpp-punkti tagastatud turukood.

market_idStringKohustuslik

Konteksti lõpp-punkti tagastatud turuidentifikaator.

paginationPagination Kohustuslik

Kursoripõhise lehekülgjaotuse metaandmed.

request_idStringKohustuslik

Pöördumise identifikaator; vastuse metaandmetes tähistab see HTTP-päringut.

minLength: 1maxLength: 100

ContextMeta

localeStringKohustuslik

Selle päringu jaoks valitud keel.

market_codeStringKohustuslik

Konteksti lõpp-punkti tagastatud turukood.

market_idStringKohustuslik

Konteksti lõpp-punkti tagastatud turuidentifikaator.

request_idStringKohustuslik

Pöördumise identifikaator; vastuse metaandmetes tähistab see HTTP-päringut.

minLength: 1maxLength: 100

PageMeta

paginationPagination Kohustuslik

Kursoripõhise lehekülgjaotuse metaandmed.

request_idStringKohustuslik

Pöördumise identifikaator; vastuse metaandmetes tähistab see HTTP-päringut.

minLength: 1maxLength: 100

RequestMeta

request_idStringKohustuslik

Pöördumise identifikaator; vastuse metaandmetes tähistab see HTTP-päringut.

minLength: 1maxLength: 100
Vastuse näide

HTTP-olek

200
Edukas vastus Skeem
400
Vigane päring
401
Autentimine on nõutav
403
Juurdepääs keelatud
404
Ressurssi ei leitud
409
Versioonikonflikt
422
Valideerimine nurjus
429
Päringupiirang ületatud
Muud HTTP olekud (7)
405
Meetod pole lubatud
413
Päring on liiga suur
415
Vormingut ei toetata
500
Serveri viga
502
API lüüsi viga
503
Teenus pole saadaval
504
Ajalimiit ületatud

Veakataloog: ErrorResponse

Päised

401

WWW-AuthenticateStringValikuline

Serveri nõutav autentimisskeem.

405

AllowStringValikuline

Selle ressursi toetatud HTTP-meetodid.

429, 503

Retry-AfterTäisarvValikuline

Minimaalne viivitus enne korduskatset, sekundites.

minimum: 0