Μετάβαση στο περιεχόμενο
ShopentlyLearn

Ανάκτηση — Παραλαβές αποθέματος

Διαβάστε δεδομένα από «Παραλαβές αποθέματος». Το αποτέλεσμα εξαρτάται από τις παραμέτρους της ενέργειας.

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

Έλεγχος ταυτότητας
Bearer
Διαθέσιμο από
STANDARD
Απαιτούμενα δικαιώματα
inventory.stock_delivery:read

Παραδείγματα κώδικα

Παράδειγμα αιτήματος

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

Παράδειγμα απόκρισης 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"
  }
}

Αρχές

  • Μια παραλαβή προσδιορίζει προϊόν ή παραλλαγή, αποθήκη, θέση, ποσότητα, ημερομηνία και κατάσταση.
  • Επιλέγετε ρητά planned ή received και ορίζετε το increases_stock σύμφωνα με την επιθυμητή επίδραση στο απόθεμα.
  • Η δημιουργία παραλαβής σε κατάσταση received μπορεί να αλλάξει το απόθεμα, επομένως πρέπει να έχει εκχωρηθεί και το απαιτούμενο υπό όρους δικαίωμα αποθέματος.
  • Επαναλαμβάνετε την ίδια λογική παραλαβή με το αρχικό κλειδί ιδιοδυναμίας για να αποφύγετε διπλή καταγραφή.
  • Διαβάζετε το stock_applied_at και το τρέχον απόθεμα κατά τη συμφωνία αποτελεσμάτων.

Παράμετροι

Παράμετροι διαδρομής

delivery_idΣυμβολοσειράΥποχρεωτικό

Αναγνωριστικό παραλαβής αποθήκης.

Περιορισμοί
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Παράδειγμα: "example"

Αυτή η λειτουργία δεν δέχεται περιεχόμενο JSON.

Αποκρίσεις

Απόκριση 200

dataDeliveryDetailData Υποχρεωτικό

Δεδομένα επιτυχούς απόκρισης.

Πεδία · data
created_atΣυμβολοσειράΥποχρεωτικό

Χρόνος δημιουργίας.

format: "date-time"
deleted_atΣυμβολοσειρά nullΥποχρεωτικό

Χρόνος διαγραφής, εφόσον υπάρχει.

Συμβολοσειρά:format: "date-time"
delivered_atΣυμβολοσειράΥποχρεωτικό

Ημερομηνία και ώρα παράδοσης.

format: "date-time"
idΣυμβολοσειράΥποχρεωτικό

Αναγνωριστικό πόρου· διατηρήστε το ακριβώς όπως επιστρέφεται.

increases_stockΛογική τιμήΥποχρεωτικό

Δείχνει αν η παραλαβή αυξάνει το απόθεμα.

location_idΣυμβολοσειράΥποχρεωτικό

Αναγνωριστικό θέσης αποθήκης.

notesΣυμβολοσειρά nullΥποχρεωτικό

Πρόσθετες σημειώσεις.

quantityΑκέραιοςΥποχρεωτικό

Πλήθος μονάδων.

received_atΣυμβολοσειρά nullΥποχρεωτικό

Ημερομηνία και ώρα παραλαβής στην αποθήκη.

Συμβολοσειρά:format: "date-time"
record_statusΣυμβολοσειράΥποχρεωτικό

Αποθηκευμένη κατάσταση εγγραφής.

Περιορισμοί
enum
["active", "deleted"]
statusΣυμβολοσειράΥποχρεωτικό

Κατάσταση αποδεκτή από τη συγκεκριμένη λειτουργία.

Περιορισμοί
enum
["planned", "received"]
stock_applied_atΣυμβολοσειρά nullΥποχρεωτικό

Ημερομηνία και ώρα εφαρμογής της αλλαγής αποθέματος της παραλαβής.

Συμβολοσειρά:format: "date-time"
target_idΣυμβολοσειράΥποχρεωτικό

Αναγνωριστικό προϊόντος ή παραλλαγής που επηρεάζει η λειτουργία.

target_typeΣυμβολοσειράΥποχρεωτικό

Δείχνει αν η λειτουργία αφορά προϊόν ή παραλλαγή.

Περιορισμοί
enum
["product", "variant"]
updated_atΣυμβολοσειρά nullΥποχρεωτικό

Χρόνος τελευταίας ενημέρωσης.

Συμβολοσειρά:format: "date-time"
versionΑκέραιοςΥποχρεωτικό

Έκδοση πόρου για έλεγχο ταυτόχρονων εγγραφών.

warehouse_idΣυμβολοσειράΥποχρεωτικό

Αναγνωριστικό αποθήκης.

metaContextPageMeta ContextMeta PageMeta RequestMeta Υποχρεωτικό

Μεταδεδομένα απόκρισης.

Πεδία · meta

ContextPageMeta

localeΣυμβολοσειράΥποχρεωτικό

Γλώσσα που επιλέχθηκε για αυτό το αίτημα.

market_codeΣυμβολοσειράΥποχρεωτικό

Κωδικός αγοράς που επιστρέφει το endpoint πλαισίου.

market_idΣυμβολοσειράΥποχρεωτικό

Αναγνωριστικό αγοράς που επιστρέφει το endpoint πλαισίου.

paginationPagination Υποχρεωτικό

Μεταδεδομένα σελιδοποίησης με cursor.

request_idΣυμβολοσειράΥποχρεωτικό

Αναγνωριστικό αιτήματος· στα μεταδεδομένα απόκρισης ταυτοποιεί το αίτημα HTTP.

minLength: 1maxLength: 100

ContextMeta

localeΣυμβολοσειράΥποχρεωτικό

Γλώσσα που επιλέχθηκε για αυτό το αίτημα.

market_codeΣυμβολοσειράΥποχρεωτικό

Κωδικός αγοράς που επιστρέφει το endpoint πλαισίου.

market_idΣυμβολοσειράΥποχρεωτικό

Αναγνωριστικό αγοράς που επιστρέφει το endpoint πλαισίου.

request_idΣυμβολοσειράΥποχρεωτικό

Αναγνωριστικό αιτήματος· στα μεταδεδομένα απόκρισης ταυτοποιεί το αίτημα HTTP.

minLength: 1maxLength: 100

PageMeta

paginationPagination Υποχρεωτικό

Μεταδεδομένα σελιδοποίησης με cursor.

request_idΣυμβολοσειράΥποχρεωτικό

Αναγνωριστικό αιτήματος· στα μεταδεδομένα απόκρισης ταυτοποιεί το αίτημα HTTP.

minLength: 1maxLength: 100

RequestMeta

request_idΣυμβολοσειράΥποχρεωτικό

Αναγνωριστικό αιτήματος· στα μεταδεδομένα απόκρισης ταυτοποιεί το αίτημα HTTP.

minLength: 1maxLength: 100
Παράδειγμα απόκρισης

Κατάσταση HTTP

200
Επιτυχής απόκριση Σχήμα
400
Μη έγκυρο αίτημα
401
Απαιτείται ταυτοποίηση
403
Δεν επιτρέπεται η πρόσβαση
404
Ο πόρος δεν βρέθηκε
409
Διένεξη έκδοσης
422
Αποτυχία επικύρωσης
429
Υπέρβαση ορίου αιτημάτων
Άλλες καταστάσεις HTTP (7)
405
Η μέθοδος δεν επιτρέπεται
413
Πολύ μεγάλο αίτημα
415
Μη υποστηριζόμενος τύπος
500
Σφάλμα διακομιστή
502
Σφάλμα πύλης API
503
Μη διαθέσιμη υπηρεσία
504
Υπέρβαση χρόνου αναμονής

Κατάλογος σφαλμάτων: ErrorResponse

Κεφαλίδες

401

WWW-AuthenticateΣυμβολοσειράΠροαιρετικό

Σχήμα ελέγχου ταυτότητας που απαιτεί ο διακομιστής.

405

AllowΣυμβολοσειράΠροαιρετικό

Μέθοδοι HTTP που υποστηρίζει αυτός ο πόρος.

429, 503

Retry-AfterΑκέραιοςΠροαιρετικό

Ελάχιστος χρόνος αναμονής πριν από νέα προσπάθεια, σε δευτερόλεπτα.

minimum: 0