Gå til indhold
ShopentlyLearn

Hent — Leverancer

Læs data fra ”Leverancer”. Resultatet afhænger af handlingens parametre.

GET/api/v1/inventory/deliveries/{delivery_id}

Godkendelse
Bearer
Tilgængelig fra
STANDARD
Nødvendige rettigheder
inventory.stock_delivery:read

Kodeeksempler

Eksempel på forespørgsel

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/example

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/example');
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/example', 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))

Eksempel på svar 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",
    "notes": "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": {
    "request_id": "example"
  }
}

Principper

  • En leverance identificerer et produkt eller en variant, et lager, en lagerplacering, en mængde, en dato og en status.
  • Vælg planned eller received eksplicit, og indstil increases_stock efter den ønskede lagerpåvirkning.
  • Oprettelse af en modtaget leverance kan ændre lagerbeholdningen, så den nødvendige betingede lagerrettighed skal også være tildelt.
  • Gentag den samme logiske leverance med den oprindelige idempotensnøgle for at undgå dobbeltregistrering.
  • Læs stock_applied_at og den aktuelle lagerbeholdning, når resultater afstemmes.

Parametre

Stiparametre

delivery_idStrengObligatorisk

Leveranceidentifikator.

Begrænsninger
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Eksempel: "example"

Denne operation accepterer ikke JSON-indhold.

Svar

Svar 200

dataDeliveryDetailData Obligatorisk

Indholdet af et vellykket svar.

Felter · data
created_atStrengObligatorisk

Oprettelsestidspunkt.

format: "date-time"
deleted_atStreng nullObligatorisk

Sletningstidspunkt, hvis det findes.

Streng:format: "date-time"
delivered_atStrengObligatorisk

Leveringsdato og -tidspunkt.

format: "date-time"
idStrengObligatorisk

Ressourceidentifikator; bevar den som returneret.

increases_stockBoolesk værdiObligatorisk

Om modtagelse af leverancen øger lagerbeholdningen.

location_idStrengObligatorisk

Identifikator for lagerplacering.

notesStreng nullObligatorisk

Yderligere bemærkninger.

quantityHeltalObligatorisk

Antal enheder.

received_atStreng nullObligatorisk

Dato og tidspunkt for modtagelse af leverancen.

Streng:format: "date-time"
record_statusStrengObligatorisk

Gemt poststatus.

Begrænsninger
enum
["active", "deleted"]
statusStrengObligatorisk

Status accepteret af denne specifikke operation.

Begrænsninger
enum
["planned", "received"]
stock_applied_atStreng nullObligatorisk

Dato og tidspunkt, hvor leverancens lagerændring blev anvendt.

Streng:format: "date-time"
target_idStrengObligatorisk

Identifikator for produktet eller varianten, som operationen påvirker.

target_typeStrengObligatorisk

Om operationen vedrører et produkt eller en variant.

Begrænsninger
enum
["product", "variant"]
updated_atStreng nullObligatorisk

Tidspunkt for seneste opdatering.

Streng:format: "date-time"
versionHeltalObligatorisk

Ressourceversion anvendt til samtidighedskontrol.

warehouse_idStrengObligatorisk

Lageridentifikator.

metaContextPageMeta ContextMeta PageMeta RequestMeta Obligatorisk

Svarmetadata.

Felter · meta

ContextPageMeta

localeStrengObligatorisk

Sprog valgt til denne forespørgsel.

market_codeStrengObligatorisk

Markedskode returneret af kontekstendepunktet.

market_idStrengObligatorisk

Markedsidentifikator returneret af kontekstendepunktet.

paginationPagination Obligatorisk

Metadata for markørbaseret sideinddeling.

request_idStrengObligatorisk

Sagsidentifikator; i svarmetadata identificerer den HTTP-forespørgslen.

minLength: 1maxLength: 100

ContextMeta

localeStrengObligatorisk

Sprog valgt til denne forespørgsel.

market_codeStrengObligatorisk

Markedskode returneret af kontekstendepunktet.

market_idStrengObligatorisk

Markedsidentifikator returneret af kontekstendepunktet.

request_idStrengObligatorisk

Sagsidentifikator; i svarmetadata identificerer den HTTP-forespørgslen.

minLength: 1maxLength: 100

PageMeta

paginationPagination Obligatorisk

Metadata for markørbaseret sideinddeling.

request_idStrengObligatorisk

Sagsidentifikator; i svarmetadata identificerer den HTTP-forespørgslen.

minLength: 1maxLength: 100

RequestMeta

request_idStrengObligatorisk

Sagsidentifikator; i svarmetadata identificerer den HTTP-forespørgslen.

minLength: 1maxLength: 100
Eksempel på svar

HTTP-status

200
Vellykket svar Skema
400
Ugyldig anmodning
401
Godkendelse påkrævet
403
Adgang nægtet
404
Ressource ikke fundet
409
Versionskonflikt
422
Validering mislykkedes
429
Grænsen for anmodninger er overskredet
Andre HTTP-statusser (7)
405
Metoden er ikke tilladt
413
Anmodningen er for stor
415
Formatet understøttes ikke
500
Serverfejl
502
Fejl i API-gateway
503
Tjenesten er utilgængelig
504
Tidsgrænsen er overskredet

Fejlkatalog: ErrorResponse

Headere

401

WWW-AuthenticateStrengValgfrit

Godkendelsesmetode, som serveren kræver.

405

AllowStrengValgfrit

HTTP-metoder, som denne ressource understøtter.

429, 503

Retry-AfterHeltalValgfrit

Mindste ventetid før næste forsøg, i sekunder.

minimum: 0