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

Списък — Поръчки

Прочетете данни от „Поръчки“. Резултатът зависи от параметрите на операцията.

GET/api/v1/orders

Удостоверяване
Bearer
Достъпно от
BASIC
Необходими права
orders.order:read

Примери с код

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

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/orders?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/orders?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/orders?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))

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

JSON
{
  "data": [
    {
      "created_at": "2026-10-19T10:00:00Z",
      "customer": {
        "email": "customer@example.invalid",
        "first_name": "Example",
        "last_name": "Example",
        "phone": null
      },
      "delivery": {
        "amount": {
          "amount": "0.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "dates": {
          "dispatch_timezone": "Europe/Warsaw",
          "estimated_delivery_from": "2026-10-20",
          "estimated_delivery_to": "2026-10-21",
          "planned_dispatch_on": "2026-10-19"
        },
        "method_code": "shipping-old",
        "method_name": "Historic carrier",
        "pickup_point": null,
        "recipient_mode": "full_address"
      },
      "discount_amount": {
        "amount": "24.60",
        "currency": "PLN",
        "minor_units": 2
      },
      "id": "order-0000",
      "lifecycle_state": "placed",
      "locale": "pl",
      "market_id": "market-pl",
      "number": "0001",
      "payment": {
        "amount": {
          "amount": "329.40",
          "currency": "PLN",
          "minor_units": 2
        },
        "environment": "live",
        "method_code": "payment-old",
        "method_name": "Historic method",
        "paid_at": null,
        "status": "unpaid",
        "updated_at": "2026-10-19T10:00:00Z",
        "version": 0
      },
      "prices_include_tax": true,
      "shipping_discount_amount": {
        "amount": "24.60",
        "currency": "PLN",
        "minor_units": 2
      },
      "status": {
        "id": "status-0",
        "name": "Status 0",
        "updated_at": "2026-10-19T10:00:00Z",
        "version": 1
      },
      "subtotal": {
        "amount": "329.40",
        "currency": "PLN",
        "minor_units": 2
      },
      "tax": {
        "amount": "49.40",
        "currency": "PLN",
        "minor_units": 2
      },
      "tax_country_code": "PL",
      "total": {
        "amount": "329.40",
        "currency": "PLN",
        "minor_units": 2
      }
    }
  ],
  "meta": {
    "pagination": {
      "has_more": false,
      "limit": 20,
      "next_cursor": null
    },
    "request_id": "example"
  }
}

Как работи

  • Списъкът предоставя обобщения и филтри по номер, статус, статус на плащане и време на създаване.
  • Списъкът и подробностите за поръчките включват delivery.dates. Планираните дати YYYY-MM-DD не потвърждават изпращане. Текущите дати имат предимство; старите поръчки използват записаната прогноза. Изтритите или неизвестни стойности са null. Подробностите включват и всички позиции и изображения на продуктите.
  • Получете валидните идентификатори на статуси от /api/v1/order-statuses.
  • Статусът на поръчката и статусът на плащането използват отделни PATCH endpoints и права.
  • Промяната на записания статус на плащане не таксува карта и не възстановява сума чрез платежен доставчик.

Поръчка · Общи суми

Сумите и ставките идват от запазената поръчка, включително корекциите на редове. Липсващите исторически данни са null и не се заменят с текущите ставки от каталога. Сумите остават десетични низове.

Списъкът връща обобщения. За всеки резултат извлечете GET /api/v1/orders/{order_id} за пълни финансови данни. Повторенията на GET са ограничени и спазват Retry-After. Експортът по дата на създаване не синхронизира по-късни корекции.

Параметри

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

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

Максимален брой записи на тази страница.

minimum: 1maximum: 100
По подразбиране: 50Пример: 20
cursorНиз nullНезадължително

Непрозрачна стойност за продължаване, върната от предишната страница.

Низ:minLength: 1maxLength: 1024
numberНиз nullНезадължително

Номер на поръчката или искането, предназначен за потребителя.

Низ:minLength: 1maxLength: 48
status_idНиз nullНезадължително

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

Ограничения · Низ 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
payment_statusНиз nullНезадължително

Записан статус на плащането.

Ограничения · Низ 1
enum
["unpaid", "paid", "failed", "refunded"]
created_fromНиз nullНезадължително

Начало на филтъра по време на създаване.

Низ:format: "date-time"
created_toНиз nullНезадължително

Край на филтъра по време на създаване.

Низ:format: "date-time"

Тази операция не приема JSON тяло.

Отговори

Отговор 200

dataМасив <OrderSummaryData > Задължително

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

Полета · data

OrderSummaryData

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

Време на създаване.

format: "date-time"
customerCustomerData Задължително

Клиентски данни, записани за този ресурс.

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

Метод на доставка и свързана информация.

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

Десетична сума, кодирана като JSON низ; null само когато е позволено.

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

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

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

Състояние в бизнес жизнения цикъл.

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

Език, избран за тази заявка.

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

Идентификатор на пазара, върнат от endpoint за контекст.

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

Номер на поръчката или искането, предназначен за потребителя.

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

Данни за плащането, записани към поръчката.

prices_include_taxБулева стойностЗадължително

Дали посочените цени включват данък.

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

Десетична сума, кодирана като JSON низ; null само когато е позволено.

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

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

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

Сума преди допълнителните компоненти, показани в отговора.

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

Данъчна информация.

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

Данъчна държава · Запазени данни на поръчката · ISO 3166-1 alpha-2; null.

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

Обща сума.

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

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

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

Заглавки

401

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

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

405

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

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

429, 503

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

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

minimum: 0