Preskoči na vsebino
ShopentlyLearn

Ustvari — Dobave

Izvedite »Ustvari« v »Dobave« s spodaj opisanimi podatki.

POST/api/v1/inventory/deliveries

Preverjanje pristnosti
Bearer
Na voljo od paketa
STANDARD
Zahtevana dovoljenja
inventory.stock_delivery:create

Primeri kode

Primer zahteve

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_delivery_api_v1_inventory_deliveries_post' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "delivered_at": "2026-01-01T00:00:00Z",
  "location_id": "example",
  "quantity": 1,
  "status": "planned",
  "target_id": "example",
  "target_type": "product",
  "warehouse_id": "example"
}' \
  --url "${SHOPENTLY_SHOP_URL%/}"/api/v1/inventory/deliveries

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_delivery_api_v1_inventory_deliveries_post', 'Content-Type: application/json'];
$headers[] = 'Authorization: Bearer ' . $credential;
$responseHeaders = [];
$handle = curl_init($baseUrl . '/api/v1/inventory/deliveries');
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, '{
  "delivered_at": "2026-01-01T00:00:00Z",
  "location_id": "example",
  "quantity": 1,
  "status": "planned",
  "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_delivery_api_v1_inventory_deliveries_post'}
headers["Authorization"] = 'Bearer' + " " + credential
body = '{\n  "delivered_at": "2026-01-01T00:00:00Z",\n  "location_id": "example",\n  "quantity": 1,\n  "status": "planned",\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/deliveries', 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))

Primer odgovora 201

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

Kako deluje

  • Dobava določa izdelek ali različico, skladišče, lokacijo, količino, datum in status.
  • Izrecno izberite planned ali received in nastavite increases_stock glede na želeni vpliv na zalogo.
  • Ustvarjanje prejete dobave lahko spremeni zalogo, zato mora biti dodeljeno tudi zahtevano pogojno dovoljenje za zalogo.
  • Isto logično dobavo ponovite z izvirnim ključem idempotentnosti, da je ne zabeležite dvakrat.
  • Pri usklajevanju rezultatov preberite stock_applied_at in trenutno zalogo.

Parametri

Glave zahteve

Idempotency-KeyNizObvezno

Enolični identifikator ene logične operacije zapisa.

minLength: 1maxLength: 128
Omejitve
pattern
"^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$"
Primer: "example-create_delivery_api_v1_inventory_deliveries_post"

Telo zahteve

application/json · Obvezno

DeliveryCreate
delivered_atNizObvezno

Datum in čas dostave.

format: "date-time"
Primer: "2026-01-01T00:00:00Z"
increases_stockLogična vrednostIzbirno

Ali prejem dobave poveča zalogo.

Privzeto: true
location_idNizObvezno

Identifikator lokacije skladišča.

Omejitve
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Primer: "example"
notesNizIzbirno

Dodatne opombe.

maxLength: 2000
Privzeto: ""
quantityCelo številoObvezno

Število enot.

minimum: 1maximum: 2147483647
Primer: 1
reasonNizIzbirno

Zabeleženi razlog spremembe.

maxLength: 500
Privzeto: ""
statusNizObvezno

Status, ki ga sprejema ta operacija.

Omejitve
enum
["planned", "received"]
Primer: "planned"
target_idNizObvezno

Identifikator izdelka ali različice, na katero vpliva operacija.

Omejitve
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Primer: "example"
target_typeNizObvezno

Ali se operacija nanaša na izdelek ali različico.

Omejitve
enum
["product", "variant"]
Primer: "product"
warehouse_idNizObvezno

Identifikator skladišča.

Omejitve
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Primer: "example"

Odgovori

Odgovor 201

dataMutationData Obvezno

Vsebina uspešnega odgovora.

Polja · data
deletedLogična vrednostObvezno

Ali je bilo brisanje izvedeno.

idNizObvezno

Identifikator vira; ohranite ga v vrnjeni obliki.

versionCelo število nullObvezno

Različica vira za nadzor sočasnosti.

metaContextPageMeta ContextMeta PageMeta RequestMeta Obvezno

Metapodatki odgovora.

Polja · meta

ContextPageMeta

localeNizObvezno

Jezik, izbran za to zahtevo.

market_codeNizObvezno

Koda trga, vrnjena s končno točko konteksta.

market_idNizObvezno

Identifikator trga, vrnjen s končno točko konteksta.

paginationPagination Obvezno

Metapodatki straničenja s kazalcem.

request_idNizObvezno

Identifikator zahtevka; v metapodatkih odgovora označuje zahtevo HTTP.

minLength: 1maxLength: 100

ContextMeta

localeNizObvezno

Jezik, izbran za to zahtevo.

market_codeNizObvezno

Koda trga, vrnjena s končno točko konteksta.

market_idNizObvezno

Identifikator trga, vrnjen s končno točko konteksta.

request_idNizObvezno

Identifikator zahtevka; v metapodatkih odgovora označuje zahtevo HTTP.

minLength: 1maxLength: 100

PageMeta

paginationPagination Obvezno

Metapodatki straničenja s kazalcem.

request_idNizObvezno

Identifikator zahtevka; v metapodatkih odgovora označuje zahtevo HTTP.

minLength: 1maxLength: 100

RequestMeta

request_idNizObvezno

Identifikator zahtevka; v metapodatkih odgovora označuje zahtevo HTTP.

minLength: 1maxLength: 100
Primer odgovora

Status HTTP

201
Vir ustvarjen Shema
400
Neveljavna zahteva
401
Potrebna je avtentikacija
403
Dostop zavrnjen
404
Vir ni najden
409
Spor različic
422
Preverjanje ni uspelo
429
Presežena omejitev zahtev
Druga stanja HTTP (7)
405
Metoda ni dovoljena
413
Zahteva je prevelika
415
Nepodprta oblika
500
Napaka strežnika
502
Napaka prehoda API
503
Storitev ni na voljo
504
Časovna omejitev je potekla

Katalog napak: ErrorResponse

Glave

201

LocationNizIzbirno

Relativni URL ustvarjenega vira.

401

WWW-AuthenticateNizIzbirno

Shema preverjanja pristnosti, ki jo zahteva strežnik.

405

AllowNizIzbirno

Metode HTTP, ki jih podpira ta vir.

429, 503

Retry-AfterCelo številoIzbirno

Najkrajši zamik pred ponovitvijo v sekundah.

minimum: 0