Pereiti prie turinio
ShopentlyLearn

Sukurti — Tiekimai

Atlikite „Sukurti“ ištekliuje „Tiekimai“ naudodami toliau aprašytus duomenis.

POST/api/v1/inventory/deliveries

Tapatybės patvirtinimas
Bearer
Prieinama nuo plano
STANDARD
Būtinos teisės
inventory.stock_delivery:create

Kodo pavyzdžiai

Užklausos pavyzdys

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

Atsakymo pavyzdys 201

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

Kaip tai veikia

  • Tiekimas nurodo produktą arba variantą, sandėlį, vietą, kiekį, datą ir būseną.
  • Aiškiai pasirinkite planned arba received ir nustatykite increases_stock pagal norimą poveikį atsargoms.
  • Sukūrus gautą tiekimą gali pasikeisti atsargos, todėl taip pat reikia suteiktos sąlyginės atsargų teisės.
  • Tą patį loginį tiekimą kartokite su pradiniu idempotentiškumo raktu, kad jis nebūtų užregistruotas du kartus.
  • Derindami rezultatus perskaitykite stock_applied_at ir dabartines atsargas.

Parametrai

Užklausos antraštės

Idempotency-KeyEilutėPrivalomas

Vienos loginės įrašymo operacijos unikalus identifikatorius.

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

Užklausos turinys

application/json · Privalomas

DeliveryCreate
delivered_atEilutėPrivalomas

Pristatymo data ir laikas.

format: "date-time"
Pavyzdys: "2026-01-01T00:00:00Z"
increases_stockLoginė reikšmėNeprivalomas

Ar tiekimo priėmimas padidina atsargas.

Numatytoji reikšmė: true
location_idEilutėPrivalomas

Sandėlio vietos identifikatorius.

Apribojimai
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Pavyzdys: "example"
notesEilutėNeprivalomas

Papildomos pastabos.

maxLength: 2000
Numatytoji reikšmė: ""
quantitySveikasis skaičiusPrivalomas

Vienetų skaičius.

minimum: 1maximum: 2147483647
Pavyzdys: 1
reasonEilutėNeprivalomas

Užregistruota pakeitimo priežastis.

maxLength: 500
Numatytoji reikšmė: ""
statusEilutėPrivalomas

Šios konkrečios operacijos priimama būsena.

Apribojimai
enum
["planned", "received"]
Pavyzdys: "planned"
target_idEilutėPrivalomas

Operacijos paveikto produkto arba varianto identifikatorius.

Apribojimai
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Pavyzdys: "example"
target_typeEilutėPrivalomas

Ar operacija skirta produktui, ar variantui.

Apribojimai
enum
["product", "variant"]
Pavyzdys: "product"
warehouse_idEilutėPrivalomas

Sandėlio identifikatorius.

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

Atsakymai

Atsakymas 201

dataMutationData Privalomas

Sėkmingo atsakymo duomenys.

Laukai · data
deletedLoginė reikšmėPrivalomas

Ar šalinimas buvo atliktas.

idEilutėPrivalomas

Ištekliaus identifikatorius; išsaugokite grąžintą išraišką.

versionSveikasis skaičius nullPrivalomas

Ištekliaus versija lygiagrečių pakeitimų kontrolei.

metaContextPageMeta ContextMeta PageMeta RequestMeta Privalomas

Atsakymo metaduomenys.

Laukai · meta

ContextPageMeta

localeEilutėPrivalomas

Šiai užklausai pasirinkta kalba.

market_codeEilutėPrivalomas

Konteksto prieigos taško grąžintas rinkos kodas.

market_idEilutėPrivalomas

Konteksto prieigos taško grąžintas rinkos identifikatorius.

paginationPagination Privalomas

Skaidymo į puslapius pagal žymeklį metaduomenys.

request_idEilutėPrivalomas

Prašymo identifikatorius; atsakymo metaduomenyse nurodo HTTP užklausą.

minLength: 1maxLength: 100

ContextMeta

localeEilutėPrivalomas

Šiai užklausai pasirinkta kalba.

market_codeEilutėPrivalomas

Konteksto prieigos taško grąžintas rinkos kodas.

market_idEilutėPrivalomas

Konteksto prieigos taško grąžintas rinkos identifikatorius.

request_idEilutėPrivalomas

Prašymo identifikatorius; atsakymo metaduomenyse nurodo HTTP užklausą.

minLength: 1maxLength: 100

PageMeta

paginationPagination Privalomas

Skaidymo į puslapius pagal žymeklį metaduomenys.

request_idEilutėPrivalomas

Prašymo identifikatorius; atsakymo metaduomenyse nurodo HTTP užklausą.

minLength: 1maxLength: 100

RequestMeta

request_idEilutėPrivalomas

Prašymo identifikatorius; atsakymo metaduomenyse nurodo HTTP užklausą.

minLength: 1maxLength: 100
Atsakymo pavyzdys

HTTP būsena

201
Išteklius sukurtas Schema
400
Netinkama užklausa
401
Būtinas tapatybės patvirtinimas
403
Prieiga uždrausta
404
Išteklius nerastas
409
Versijų konfliktas
422
Tikrinimo klaida
429
Viršytas užklausų limitas
Kitos HTTP būsenos (7)
405
Metodas neleidžiamas
413
Užklausa per didelė
415
Nepalaikomas formatas
500
Serverio klaida
502
API tinklų sietuvo klaida
503
Paslauga nepasiekiama
504
Baigėsi laukimo laikas

Klaidų katalogas: ErrorResponse

Antraštės

201

LocationEilutėNeprivalomas

Sukurto ištekliaus santykinis URL.

401

WWW-AuthenticateEilutėNeprivalomas

Serverio reikalaujama tapatybės patvirtinimo schema.

405

AllowEilutėNeprivalomas

Šio ištekliaus palaikomi HTTP metodai.

429, 503

Retry-AfterSveikasis skaičiusNeprivalomas

Mažiausias laukimo laikas prieš kartojant, sekundėmis.

minimum: 0