Zum Inhalt springen
ShopentlyLearn

Erstellen · Bestandskorrektur — Lagerbestände

Führen Sie „Erstellen · Bestandskorrektur“ in „Lagerbestände“ mit den unten beschriebenen Daten aus.

POST/api/v1/inventory/stock-adjustments

Authentifizierung
Bearer
Verfügbar ab
STANDARD
Erforderliche Berechtigungen
inventory.stock:update

Codebeispiele

Beispielanfrage

cURL

: "${SHOPENTLY_SHOP_URL:?}"

curl --disable --globoff --fail-with-body --silent --show-error \
  --proto '=https' --connect-timeout 5 --max-time 30 \
  --request POST \
  --header "Authorization: Bearer ${SHOPENTLY_ACCESS_TOKEN:?}" \
  --header 'Idempotency-Key: example-create_adjustment_api_v1_inventory_stock_adjustments_post' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "expected_version": 0,
  "locations": [
    {
      "location_id": "example",
      "on_hand": 1
    }
  ],
  "reason": "Example",
  "target_id": "example",
  "target_type": "product",
  "warehouse_id": "example"
}' \
  --url "${SHOPENTLY_SHOP_URL%/}"/api/v1/inventory/stock-adjustments

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 = ['Idempotency-Key: example-create_adjustment_api_v1_inventory_stock_adjustments_post', 'Content-Type: application/json'];
$headers[] = 'Authorization: Bearer ' . $credential;
$responseHeaders = [];
$handle = curl_init($baseUrl . '/api/v1/inventory/stock-adjustments');
curl_setopt_array($handle, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    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);
    },
]);
curl_setopt($handle, CURLOPT_POSTFIELDS, '{
  "expected_version": 0,
  "locations": [
    {
      "location_id": "example",
      "on_hand": 1
    }
  ],
  "reason": "Example",
  "target_id": "example",
  "target_type": "product",
  "warehouse_id": "example"
}');
$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 = {'Idempotency-Key': 'example-create_adjustment_api_v1_inventory_stock_adjustments_post'}
headers["Authorization"] = 'Bearer' + " " + credential
body = '{\n  "expected_version": 0,\n  "locations": [\n    {\n      "location_id": "example",\n      "on_hand": 1\n    }\n  ],\n  "reason": "Example",\n  "target_id": "example",\n  "target_type": "product",\n  "warehouse_id": "example"\n}'
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(
        'POST', base_url + '/api/v1/inventory/stock-adjustments', 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))

Beispielantwort 201

JSON
{
  "data": {
    "deleted": false,
    "id": "stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ",
    "version": 1
  },
  "meta": {
    "request_id": "example"
  }
}

Funktionsweise

  • Bestandsdatensätze unterscheiden physischen Bestand on_hand, Bestellreservierungen, manuelle Reservierungen und verkaufsfähige Menge.
  • Verwenden Sie die zurückgegebene Bestandskennung und Version.
  • Produkt- und Variantenbestand sind getrennte Ziele.
  • sellable_limit mit -1 bedeutet unbegrenzt, 0 bedeutet keine verfügbaren Verkäufe.
  • Unbegrenzte Verfügbarkeit erscheint in available als null.
  • Interpretieren Sie null nicht als 0.
  • Bestandskorrekturen, Verkaufslimits und manuelle Reservierungen haben getrennte Operationen und Rechte.

Parameter

Anfrageheader

Idempotency-KeyZeichenfolgeErforderlich

Eindeutige Kennung eines logischen Schreibvorgangs.

minLength: 1maxLength: 128
Einschränkungen
pattern
"^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$"
Beispiel: "example-create_adjustment_api_v1_inventory_stock_adjustments_post"

Anfrageinhalt

application/json · Erforderlich

StockAdjustmentCreate
expected_versionGanzzahlErforderlich

Vor dem Schreiben gelesene Version; eine Abweichung verhindert die Änderung.

minimum: 0maximum: 9223372036854775807
Beispiel: 0
locationsArray <LocationQuantity > Erforderlich

Lagerorte.

minItems: 1maxItems: 100
Beispiel: [{"location_id":"example","on_hand":1}]
reasonZeichenfolgeErforderlich

Für die Änderung gespeicherte Begründung.

minLength: 1maxLength: 500
Beispiel: "Example"
target_idZeichenfolgeErforderlich

Kennung des von der Operation betroffenen Produkts oder der Variante.

Einschränkungen
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Beispiel: "example"
target_typeZeichenfolgeErforderlich

Gibt an, ob die Operation ein Produkt oder eine Variante betrifft.

Einschränkungen
enum
["product", "variant"]
Beispiel: "product"
warehouse_idZeichenfolgeErforderlich

Lagerkennung.

Einschränkungen
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Beispiel: "example"

Antworten

Antwort 200

dataMutationData Erforderlich

Nutzdaten einer erfolgreichen Antwort.

Felder · data
deletedBoolescher WertErforderlich

Gibt an, ob die Löschung durchgeführt wurde.

idZeichenfolgeErforderlich

Ressourcenkennung; unverändert aus der Antwort übernehmen.

versionGanzzahl nullErforderlich

Ressourcenversion zur Nebenläufigkeitskontrolle.

metaContextPageMeta ContextMeta PageMeta RequestMeta Erforderlich

Metadaten der Antwort.

Felder · meta

ContextPageMeta

localeZeichenfolgeErforderlich

Für diese Anfrage ausgewählte Sprache.

market_codeZeichenfolgeErforderlich

Vom Kontext-Endpunkt zurückgegebener Marktcode.

market_idZeichenfolgeErforderlich

Vom Kontext-Endpunkt zurückgegebene Marktkennung.

paginationPagination Erforderlich

Metadaten der Cursor-Paginierung.

request_idZeichenfolgeErforderlich

Vorgangskennung; in Antwortmetadaten die Kennung der HTTP-Anfrage.

minLength: 1maxLength: 100

ContextMeta

localeZeichenfolgeErforderlich

Für diese Anfrage ausgewählte Sprache.

market_codeZeichenfolgeErforderlich

Vom Kontext-Endpunkt zurückgegebener Marktcode.

market_idZeichenfolgeErforderlich

Vom Kontext-Endpunkt zurückgegebene Marktkennung.

request_idZeichenfolgeErforderlich

Vorgangskennung; in Antwortmetadaten die Kennung der HTTP-Anfrage.

minLength: 1maxLength: 100

PageMeta

paginationPagination Erforderlich

Metadaten der Cursor-Paginierung.

request_idZeichenfolgeErforderlich

Vorgangskennung; in Antwortmetadaten die Kennung der HTTP-Anfrage.

minLength: 1maxLength: 100

RequestMeta

request_idZeichenfolgeErforderlich

Vorgangskennung; in Antwortmetadaten die Kennung der HTTP-Anfrage.

minLength: 1maxLength: 100

Antwort 201

dataMutationData Erforderlich

Nutzdaten einer erfolgreichen Antwort.

Felder · data
deletedBoolescher WertErforderlich

Gibt an, ob die Löschung durchgeführt wurde.

idZeichenfolgeErforderlich

Ressourcenkennung; unverändert aus der Antwort übernehmen.

versionGanzzahl nullErforderlich

Ressourcenversion zur Nebenläufigkeitskontrolle.

metaContextPageMeta ContextMeta PageMeta RequestMeta Erforderlich

Metadaten der Antwort.

Felder · meta

ContextPageMeta

localeZeichenfolgeErforderlich

Für diese Anfrage ausgewählte Sprache.

market_codeZeichenfolgeErforderlich

Vom Kontext-Endpunkt zurückgegebener Marktcode.

market_idZeichenfolgeErforderlich

Vom Kontext-Endpunkt zurückgegebene Marktkennung.

paginationPagination Erforderlich

Metadaten der Cursor-Paginierung.

request_idZeichenfolgeErforderlich

Vorgangskennung; in Antwortmetadaten die Kennung der HTTP-Anfrage.

minLength: 1maxLength: 100

ContextMeta

localeZeichenfolgeErforderlich

Für diese Anfrage ausgewählte Sprache.

market_codeZeichenfolgeErforderlich

Vom Kontext-Endpunkt zurückgegebener Marktcode.

market_idZeichenfolgeErforderlich

Vom Kontext-Endpunkt zurückgegebene Marktkennung.

request_idZeichenfolgeErforderlich

Vorgangskennung; in Antwortmetadaten die Kennung der HTTP-Anfrage.

minLength: 1maxLength: 100

PageMeta

paginationPagination Erforderlich

Metadaten der Cursor-Paginierung.

request_idZeichenfolgeErforderlich

Vorgangskennung; in Antwortmetadaten die Kennung der HTTP-Anfrage.

minLength: 1maxLength: 100

RequestMeta

request_idZeichenfolgeErforderlich

Vorgangskennung; in Antwortmetadaten die Kennung der HTTP-Anfrage.

minLength: 1maxLength: 100
Beispielantwort

HTTP-Status

200
Erfolgreiche Antwort Schema
201
Ressource erstellt Schema
400
Ungültige Anfrage
401
Authentifizierung erforderlich
403
Berechtigung verweigert
404
Ressource nicht gefunden
409
Versionskonflikt
422
Validierung fehlgeschlagen
429
Anfragelimit überschritten
Weitere HTTP-Statuscodes (7)
405
Methode nicht erlaubt
413
Anfrage zu groß
415
Nicht unterstützter Medientyp
500
Serverfehler
502
API-Gateway-Fehler
503
Dienst nicht verfügbar
504
Gateway-Zeitüberschreitung

Fehlerkatalog: ErrorResponse

Header

201

LocationZeichenfolgeOptional

Relativer URL der erstellten Ressource.

401

WWW-AuthenticateZeichenfolgeOptional

Vom Server verlangtes Authentifizierungsschema.

405

AllowZeichenfolgeOptional

Von dieser Ressource unterstützte HTTP-Methoden.

429, 503

Retry-AfterGanzzahlOptional

Mindestwartezeit vor einem erneuten Versuch in Sekunden.

minimum: 0