Преминете към съдържанието
ShopentlyLearn

Създаване — Складови доставки

Изпълнете „Създаване“ в „Складови доставки“ с данните, описани по-долу.

POST/api/v1/inventory/deliveries

Удостоверяване
Bearer
Достъпно от
STANDARD
Необходими права
inventory.stock_delivery:create

Примери с код

Примерна заявка

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

Примерен отговор 201

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

Как работи

  • Доставката посочва продукт или вариант, склад, складово място, количество, дата и статус.
  • Изберете изрично planned или received и задайте increases_stock според желания ефект върху наличността.
  • Създаването на получена доставка може да промени наличността, затова трябва да е предоставено и необходимото условно складово право.
  • Повторете същата логическа доставка с първоначалния ключ за идемпотентност, за да избегнете двойно записване.
  • Проверете stock_applied_at и текущата наличност при съгласуване на резултатите.

Параметри

Заглавки на заявката

Idempotency-KeyНизЗадължително

Уникален идентификатор на една логическа операция за запис.

minLength: 1maxLength: 128
Ограничения
pattern
"^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$"
Пример: "example-create_delivery_api_v1_inventory_deliveries_post"

Тяло на заявката

application/json · Задължително

DeliveryCreate
delivered_atНизЗадължително

Дата и час на доставяне.

format: "date-time"
Пример: "2026-01-01T00:00:00Z"
increases_stockБулева стойностНезадължително

Дали получаването на доставката увеличава наличността.

По подразбиране: true
location_idНизЗадължително

Идентификатор на складовото място.

Ограничения
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Пример: "example"
notesНизНезадължително

Допълнителни бележки.

maxLength: 2000
По подразбиране: ""
quantityЦяло числоЗадължително

Брой единици.

minimum: 1maximum: 2147483647
Пример: 1
reasonНизНезадължително

Записана причина за промяната.

maxLength: 500
По подразбиране: ""
statusНизЗадължително

Статус, приеман от тази конкретна операция.

Ограничения
enum
["planned", "received"]
Пример: "planned"
target_idНизЗадължително

Идентификатор на продукта или варианта, засегнат от операцията.

Ограничения
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Пример: "example"
target_typeНизЗадължително

Дали операцията се отнася за продукт или вариант.

Ограничения
enum
["product", "variant"]
Пример: "product"
warehouse_idНизЗадължително

Идентификатор на склада.

Ограничения
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Пример: "example"

Отговори

Отговор 201

dataMutationData Задължително

Данни на успешния отговор.

Полета · data
deletedБулева стойностЗадължително

Дали изтриването е приложено.

idНизЗадължително

Идентификатор на ресурса; запазете го във върнатия вид.

versionЦяло число nullЗадължително

Версия на ресурса за контрол на едновременни записи.

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 статус

201
Ресурсът е създаден Схема
400
Невалидна заявка
401
Необходима е автентикация
403
Достъпът е отказан
404
Ресурсът не е намерен
409
Конфликт на версии
422
Грешка при валидиране
429
Надвишен лимит на заявките
Други HTTP статуси (7)
405
Методът не е разрешен
413
Твърде голяма заявка
415
Неподдържан формат
500
Грешка в сървъра
502
Грешка в API шлюза
503
Услугата е недостъпна
504
Времето за изчакване изтече

Каталог на грешките: ErrorResponse

Заглавки

201

LocationНизНезадължително

Относителен URL на създадения ресурс.

401

WWW-AuthenticateНизНезадължително

Схема за удостоверяване, изисквана от сървъра.

405

AllowНизНезадължително

HTTP методи, поддържани от този ресурс.

429, 503

Retry-AfterЦяло числоНезадължително

Минимално изчакване преди повторение, в секунди.

minimum: 0