Skip to content
ShopentlyLearn

List inventory deliveries

List inventory deliveries using Shopently API. Parameters: limit, cursor, warehouse_id, target_type. Examples in cURL, PHP and Python.

GET/api/v1/inventory/deliveries

Authentication
Bearer
Available from
STANDARD
Required permissions
inventory.stock_delivery:read

Code examples

Request example

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?limit=20'

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?limit=20');
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?limit=20', 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))

Response example 200

JSON
{
  "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",
      "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": {
    "pagination": {
      "has_more": false,
      "limit": 20,
      "next_cursor": null
    },
    "request_id": "example"
  }
}

How it works

  • A delivery identifies a product or variant, warehouse, location, quantity, date and status.
  • Choose planned or received explicitly and set increases_stock according to the intended stock effect.
  • Creating a received delivery can change stock, so the required conditional inventory permission must also be granted.
  • Retry the same logical delivery with the original idempotency key to avoid recording it twice.
  • Read stock_applied_at and current stock when reconciling results.

Parameters

Query parameters

limitIntegerOptional

Maximum number of records on this page.

minimum: 1maximum: 100
Default: 50Example: 20
cursorString nullOptional

Opaque continuation value returned by the previous page.

String:minLength: 1maxLength: 1024
warehouse_idString nullOptional

Warehouse identifier.

Constraints · String 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
target_typeString nullOptional

Whether the operation concerns a product or a variant.

Constraints · String 1
enum
["product", "variant"]
target_idString nullOptional

Identifier of the product or variant affected by the operation.

Constraints · String 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
statusString nullOptional

Status accepted by this specific operation.

Constraints · String 1
enum
["planned", "received"]
record_statusString nullOptional

Stored record status.

Constraints · String 1
enum
["active", "deleted"]

This operation does not accept a JSON body.

Responses

Response 200

dataArray <DeliveryData > Required

Successful response payload.

Fields · data

DeliveryData

created_atStringRequired

Creation time.

format: "date-time"
deleted_atString nullRequired

Deletion time, if present.

String:format: "date-time"
delivered_atStringRequired

Delivery date and time.

format: "date-time"
idStringRequired

Resource identifier; preserve it as returned.

increases_stockBooleanRequired

Whether receipt of the delivery increases stock.

location_idStringRequired

Warehouse location identifier.

quantityIntegerRequired

Number of units.

received_atString nullRequired

Date and time the delivery was received.

String:format: "date-time"
record_statusStringRequired

Stored record status.

Constraints
enum
["active", "deleted"]
statusStringRequired

Status accepted by this specific operation.

Constraints
enum
["planned", "received"]
stock_applied_atString nullRequired

Date and time the delivery's stock change was applied.

String:format: "date-time"
target_idStringRequired

Identifier of the product or variant affected by the operation.

target_typeStringRequired

Whether the operation concerns a product or a variant.

Constraints
enum
["product", "variant"]
updated_atString nullRequired

Most recent update time.

String:format: "date-time"
versionIntegerRequired

Resource version used for concurrency control.

warehouse_idStringRequired

Warehouse identifier.

metaContextPageMeta ContextMeta PageMeta RequestMeta Required

Response metadata.

Fields · meta

ContextPageMeta

localeStringRequired

Language selected for this request.

market_codeStringRequired

Market code returned by the context endpoint.

market_idStringRequired

Market identifier returned by the context endpoint.

paginationPagination Required

Cursor pagination metadata.

request_idStringRequired

Request identifier; in response metadata this identifies the HTTP request.

minLength: 1maxLength: 100

ContextMeta

localeStringRequired

Language selected for this request.

market_codeStringRequired

Market code returned by the context endpoint.

market_idStringRequired

Market identifier returned by the context endpoint.

request_idStringRequired

Request identifier; in response metadata this identifies the HTTP request.

minLength: 1maxLength: 100

PageMeta

paginationPagination Required

Cursor pagination metadata.

request_idStringRequired

Request identifier; in response metadata this identifies the HTTP request.

minLength: 1maxLength: 100

RequestMeta

request_idStringRequired

Request identifier; in response metadata this identifies the HTTP request.

minLength: 1maxLength: 100
Response example

HTTP status

200
Successful response Schema
400
Invalid request
401
Authentication required
403
Permission denied
404
Resource not found
409
Version conflict
422
Validation failed
429
Rate limit exceeded
Other HTTP statuses (7)
405
Method not allowed
413
Request too large
415
Unsupported media type
500
Server error
502
API gateway error
503
Service unavailable
504
Gateway timeout

Error catalog: ErrorResponse

Headers

401

WWW-AuthenticateStringOptional

Authentication scheme required by the server.

405

AllowStringOptional

HTTP methods supported by this resource.

429, 503

Retry-AfterIntegerOptional

Minimum delay before retrying, in seconds.

minimum: 0