Faigh — Seachadtaí isteach
Léigh sonraí ó “Seachadtaí isteach”. Braitheann an toradh ar pharaiméadair na hoibríochta seo.
GET/api/v1/inventory/deliveries/{delivery_id}
- Fíordheimhniú
Bearer- Ar fáil ó
- STANDARD
- Ceadanna riachtanacha
inventory.stock_delivery:read
Samplaí cóid
Sampla iarratais
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))
Sampla freagra 200
{
"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"
}
}
Conas a oibríonn sé
- Sonraíonn seachadadh táirge nó athraitheach, stóras, suíomh, cainníocht, dáta agus stádas.
- Roghnaigh planned nó received go follasach agus socraigh increases_stock de réir na héifeachta atá beartaithe ar stoc.
- Féadfaidh seachadadh faighte a chruthú stoc a athrú, mar sin caithfear an cead stoic coinníollach riachtanach a dheonú freisin.
- Atriail an seachadadh loighciúil céanna leis an eochair idimpitéinse bhunaidh chun taifead dúblach a sheachaint.
- Léigh stock_applied_at agus an stoc reatha agus torthaí á réiteach.
Paraiméadair
Paraiméadair chosáin
delivery_idTeaghránRiachtanachAitheantóir seachadta.
Srianta
pattern"^[a-z0-9][a-z0-9_-]{0,62}$"
Ní ghlacann an oibríocht seo le corp JSON.
Freagraí
Freagra 200
Samhail iomlán: ApiResponse_DeliveryDetailData_
dataDeliveryDetailDataRiachtanachSonraí freagra rathúil.
Réimsí ·
dataSamhail iomlán:
DeliveryDetailDatacreated_atTeaghránRiachtanachAm cruthaithe.
format:"date-time"deleted_atTeaghrán nullRiachtanachAm scriosta, má tá sé ann.
Teaghrán:format:"date-time"delivered_atTeaghránRiachtanachDáta agus am seachadta.
format:"date-time"idTeaghránRiachtanachAitheantóir acmhainne; coinnigh mar a tugadh ar ais é.
increases_stockLuach BooleRiachtanachAn méadaíonn fáil an tseachadta an stoc.
location_idTeaghránRiachtanachAitheantóir suímh stórais.
notesTeaghrán nullRiachtanachNótaí breise.
quantitySlánuimhirRiachtanachLíon aonad.
received_atTeaghrán nullRiachtanachDáta agus am a fuarthas an seachadadh.
Teaghrán:format:"date-time"record_statusTeaghránRiachtanachStádas taifid stóráilte.
Srianta
enum["active", "deleted"]
statusTeaghránRiachtanachStádas a ghlacann an oibríocht áirithe seo.
Srianta
enum["planned", "received"]
stock_applied_atTeaghrán nullRiachtanachDáta agus am a cuireadh athrú stoic an tseachadta i bhfeidhm.
Teaghrán:format:"date-time"target_idTeaghránRiachtanachAitheantóir an táirge nó an athraithigh a dtéann an oibríocht i bhfeidhm air.
target_typeTeaghránRiachtanachAn mbaineann an oibríocht le táirge nó athraitheach.
Srianta
enum["product", "variant"]
updated_atTeaghrán nullRiachtanachAm an nuashonraithe is déanaí.
Teaghrán:format:"date-time"versionSlánuimhirRiachtanachLeagan acmhainne a úsáidtear le haghaidh rialú comhreatha.
warehouse_idTeaghránRiachtanachAitheantóir stórais.
metaContextPageMetaContextMetaPageMetaRequestMetaRiachtanachMeiteashonraí an fhreagra.
Réimsí ·
metaSamhail iomlán:
ContextPageMetalocaleTeaghránRiachtanachTeanga roghnaithe don iarratas seo.
market_codeTeaghránRiachtanachCód margaidh a thugann an críochphointe comhthéacs.
market_idTeaghránRiachtanachAitheantóir margaidh a thugann an críochphointe comhthéacs.
paginationPaginationRiachtanachMeiteashonraí leathanaithe le cúrsóir.
request_idTeaghránRiachtanachAitheantóir iarratais; i meiteashonraí freagra aithníonn sé an t-iarratas HTTP.
minLength:1maxLength:100
localeTeaghránRiachtanachTeanga roghnaithe don iarratas seo.
market_codeTeaghránRiachtanachCód margaidh a thugann an críochphointe comhthéacs.
market_idTeaghránRiachtanachAitheantóir margaidh a thugann an críochphointe comhthéacs.
request_idTeaghránRiachtanachAitheantóir iarratais; i meiteashonraí freagra aithníonn sé an t-iarratas HTTP.
minLength:1maxLength:100
paginationPaginationRiachtanachMeiteashonraí leathanaithe le cúrsóir.
request_idTeaghránRiachtanachAitheantóir iarratais; i meiteashonraí freagra aithníonn sé an t-iarratas HTTP.
minLength:1maxLength:100
request_idTeaghránRiachtanachAitheantóir iarratais; i meiteashonraí freagra aithníonn sé an t-iarratas HTTP.
minLength:1maxLength:100
Stádas HTTP
200- Freagra rathúil Scéim
400- Iarratas neamhbhailí
401- Fíordheimhniú riachtanach
403- Cead diúltaithe
404- Acmhainn gan aimsiú
409- Coinbhleacht leagain
422- Theip ar bhailíochtú
429- Teorainn iarratas sáraithe
Stádais HTTP eile (7)
405- Modh neamhcheadaithe
413- Iarratas rómhór
415- Formáid gan tacaíocht
500- Earráid freastalaí
502- Earráid gheata API
503- Seirbhís gan fáil
504- Teorainn ama sáraithe
Catalóg earráidí: ErrorResponse
Ceanntásca
401
WWW-AuthenticateTeaghránRoghnachAn scéim fíordheimhnithe a éilíonn an freastalaí.
405
AllowTeaghránRoghnachModhanna HTTP a thacaíonn an acmhainn seo leo.
429, 503
Retry-AfterSlánuimhirRoghnachAn mhoill íosta roimh atriail, i soicindí.
minimum:0