Obtenir — Livraisons
Consultez les données de « Livraisons ». Le résultat dépend des paramètres de cette opération.
GET/api/v1/inventory/deliveries/{delivery_id}
- Authentification
Bearer- Disponible à partir de
- STANDARD
- Autorisations requises
inventory.stock_delivery:read
Exemples de code
Exemple de requête
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))
Exemple de réponse 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"
}
}
Fonctionnement
- Une livraison identifie un produit ou une variante, un entrepôt, un emplacement, une quantité, une date et un statut.
- Choisissez explicitement planned ou received et définissez increases_stock selon l'effet voulu.
- Une livraison reçue peut modifier le stock ; l'autorisation conditionnelle de stock doit donc aussi être accordée.
- Réessayez la même livraison logique avec la clé d'idempotence d'origine pour éviter de l'enregistrer deux fois.
- Consultez stock_applied_at et le stock actuel pour rapprocher les résultats.
Paramètres
Paramètres de chemin
delivery_idChaîneObligatoireIdentifiant de la livraison.
Contraintes
pattern"^[a-z0-9][a-z0-9_-]{0,62}$"
Cette opération n'accepte pas de corps JSON.
Réponses
Réponse 200
Modèle complet: ApiResponse_DeliveryDetailData_
dataDeliveryDetailDataObligatoireDonnées d'une réponse réussie.
Champs ·
dataModèle complet:
DeliveryDetailDatacreated_atChaîneObligatoireDate et heure de création.
format:"date-time"deleted_atChaîne nullObligatoireDate et heure de suppression, le cas échéant.
Chaîne:format:"date-time"delivered_atChaîneObligatoireDate et heure de livraison.
format:"date-time"idChaîneObligatoireIdentifiant de ressource ; conserver la valeur renvoyée.
increases_stockBooléenObligatoireIndique si la réception de la livraison augmente le stock.
location_idChaîneObligatoireIdentifiant de l'emplacement de stockage.
notesChaîne nullObligatoireRemarques complémentaires.
quantityEntierObligatoireNombre d'unités.
received_atChaîne nullObligatoireDate et heure de réception de la livraison.
Chaîne:format:"date-time"record_statusChaîneObligatoireStatut enregistré.
Contraintes
enum["active", "deleted"]
statusChaîneObligatoireStatut accepté par cette opération précise.
Contraintes
enum["planned", "received"]
stock_applied_atChaîne nullObligatoireDate et heure d'application de la variation de stock de la livraison.
Chaîne:format:"date-time"target_idChaîneObligatoireIdentifiant du produit ou de la variante concernée par l'opération.
target_typeChaîneObligatoireIndique si l'opération concerne un produit ou une variante.
Contraintes
enum["product", "variant"]
updated_atChaîne nullObligatoireDate et heure de la dernière modification.
Chaîne:format:"date-time"versionEntierObligatoireVersion de ressource utilisée pour le contrôle de concurrence.
warehouse_idChaîneObligatoireIdentifiant de l'entrepôt.
metaContextPageMetaContextMetaPageMetaRequestMetaObligatoireMétadonnées de la réponse.
Champs ·
metaModèle complet:
ContextPageMetalocaleChaîneObligatoireLangue sélectionnée pour cette requête.
market_codeChaîneObligatoireCode de marché renvoyé par le point d'accès au contexte.
market_idChaîneObligatoireIdentifiant de marché renvoyé par le point d'accès au contexte.
paginationPaginationObligatoireMétadonnées de pagination par curseur.
request_idChaîneObligatoireIdentifiant de demande ; dans les métadonnées, identifiant de la requête HTTP.
minLength:1maxLength:100
localeChaîneObligatoireLangue sélectionnée pour cette requête.
market_codeChaîneObligatoireCode de marché renvoyé par le point d'accès au contexte.
market_idChaîneObligatoireIdentifiant de marché renvoyé par le point d'accès au contexte.
request_idChaîneObligatoireIdentifiant de demande ; dans les métadonnées, identifiant de la requête HTTP.
minLength:1maxLength:100
paginationPaginationObligatoireMétadonnées de pagination par curseur.
request_idChaîneObligatoireIdentifiant de demande ; dans les métadonnées, identifiant de la requête HTTP.
minLength:1maxLength:100
request_idChaîneObligatoireIdentifiant de demande ; dans les métadonnées, identifiant de la requête HTTP.
minLength:1maxLength:100
Statut HTTP
200- Réponse réussie Schéma
400- Requête invalide
401- Authentification requise
403- Accès refusé
404- Ressource introuvable
409- Conflit de version
422- Échec de validation
429- Limite de requêtes dépassée
Autres statuts HTTP (7)
405- Méthode non autorisée
413- Requête trop volumineuse
415- Format non pris en charge
500- Erreur du serveur
502- Erreur de passerelle API
503- Service indisponible
504- Délai de passerelle dépassé
Catalogue des erreurs: ErrorResponse
En-têtes
401
WWW-AuthenticateChaîneFacultatifSchéma d'authentification exigé par le serveur.
405
AllowChaîneFacultatifMéthodes HTTP prises en charge par cette ressource.
429, 503
Retry-AfterEntierFacultatifDélai minimal avant une nouvelle tentative, en secondes.
minimum:0