Léim ar ábhar
ShopentlyLearn

Liostaigh — Orduithe

Léigh sonraí ó “Orduithe”. Braitheann an toradh ar pharaiméadair na hoibríochta seo.

GET/api/v1/orders

Fíordheimhniú
Bearer
Ar fáil ó
BASIC
Ceadanna riachtanacha
orders.order: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/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))

Sampla freagra 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"
  }
}

Conas a oibríonn sé

  • Soláthraíonn an bailiúchán achoimrí agus scagairí de réir uimhir, stádais, stádais íocaíochta agus am cruthaithe.
  • Tá delivery.dates ar fáil sa liosta orduithe agus sna sonraí. Is dátaí pleanáilte iad YYYY-MM-DD agus ní dheimhníonn siad seoladh. Tá tosaíocht ag na dátaí reatha; úsáideann seanorduithe an meastachán sábháilte. Is null iad luachanna glanta nó anaithnide. Tá gach líne ordaithe agus íomhá táirge sna sonraí freisin.
  • Faigh aitheantóirí bailí stádais ó /api/v1/order-statuses.
  • Tá críochphointí PATCH agus ceadanna ar leith ag stádas ordaithe agus stádas íocaíochta.
  • Ní ghearrann athrú ar an stádas íocaíochta taifeadta cárta agus ní eisíonn sé aisíocaíocht trí sholáthraí íocaíochta.

Ordú · Iomláin

Tagann na méideanna agus rátaí cánach ón ordú sábháilte, lena n-áirítear ceartúcháin línte. Is null iad sonraí stairiúla atá ar iarraidh agus ní chuirtear rátaí reatha an chatalóige ina n-áit. Fanann méideanna mar theaghráin dheachúlacha.

Tugann an liosta achoimrí. Faigh GET /api/v1/orders/{order_id} do gach toradh chun na sonraí airgeadais iomlána a easpórtáil. Tá teorainn le hathiarrachtaí GET agus cloíonn siad le Retry-After. Ní shioncronaíonn easpórtáil de réir dáta cruthaithe ceartúcháin níos déanaí.

Paraiméadair

Paraiméadair fhiosrúcháin

limitSlánuimhirRoghnach

Uaslíon taifead ar an leathanach seo.

minimum: 1maximum: 100
Réamhshocrú: 50Sampla: 20
cursorTeaghrán nullRoghnach

Luach leanúna neamhléirmhínithe a tháinig ón leathanach roimhe.

Teaghrán:minLength: 1maxLength: 1024
numberTeaghrán nullRoghnach

Uimhir ordaithe nó iarratais atá le léamh ag duine.

Teaghrán:minLength: 1maxLength: 48
status_idTeaghrán nullRoghnach

Aitheantóir ón bhfoclóir stádais cuí.

Srianta · Teaghrán 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
payment_statusTeaghrán nullRoghnach

Stádas íocaíochta taifeadta.

Srianta · Teaghrán 1
enum
["unpaid", "paid", "failed", "refunded"]
created_fromTeaghrán nullRoghnach

Tús an scagaire ama cruthaithe.

Teaghrán:format: "date-time"
created_toTeaghrán nullRoghnach

Deireadh an scagaire ama cruthaithe.

Teaghrán:format: "date-time"

Ní ghlacann an oibríocht seo le corp JSON.

Freagraí

Freagra 200

dataEagar <OrderSummaryData > Riachtanach

Sonraí freagra rathúil.

Réimsí · data

OrderSummaryData

created_atTeaghránRiachtanach

Am cruthaithe.

format: "date-time"
customerCustomerData Riachtanach

Eolas custaiméara taifeadta don acmhainn seo.

deliveryShippingData Riachtanach

Modh seachadta agus eolas gaolmhar.

discount_amountMoneyData Riachtanach

Suim dheachúlach mar theaghrán JSON; null ach amháin nuair a cheadaítear é.

idTeaghránRiachtanach

Aitheantóir acmhainne; coinnigh mar a tugadh ar ais é.

lifecycle_stateOrderLifecycleState Riachtanach

Staid shaolré ghnó.

localeTeaghránRiachtanach

Teanga roghnaithe don iarratas seo.

market_idTeaghránRiachtanach

Aitheantóir margaidh a thugann an críochphointe comhthéacs.

numberTeaghránRiachtanach

Uimhir ordaithe nó iarratais atá le léamh ag duine.

paymentPaymentData Riachtanach

Sonraí íocaíochta taifeadta don ordú.

prices_include_taxLuach BooleRiachtanach

An bhfuil cáin sna praghsanna liostaithe.

shipping_discount_amountMoneyData Riachtanach

Suim dheachúlach mar theaghrán JSON; null ach amháin nuair a cheadaítear é.

statusOrderStatusData Riachtanach

Stádas a ghlacann an oibríocht áirithe seo.

subtotalMoneyData Riachtanach

Suim roimh na comhpháirteanna breise a thaispeántar sa fhreagra.

taxMoneyData Riachtanach

Eolas cánach.

tax_country_codeTeaghrán nullRiachtanach

Tír chánach · Sonraí sábháilte an ordaithe · ISO 3166-1 alpha-2; null.

totalMoneyData Riachtanach

Suim iomlán.

metaContextPageMeta ContextMeta PageMeta RequestMeta Riachtanach

Meiteashonraí an fhreagra.

Réimsí · meta

ContextPageMeta

localeTeaghránRiachtanach

Teanga roghnaithe don iarratas seo.

market_codeTeaghránRiachtanach

Cód margaidh a thugann an críochphointe comhthéacs.

market_idTeaghránRiachtanach

Aitheantóir margaidh a thugann an críochphointe comhthéacs.

paginationPagination Riachtanach

Meiteashonraí leathanaithe le cúrsóir.

request_idTeaghránRiachtanach

Aitheantóir iarratais; i meiteashonraí freagra aithníonn sé an t-iarratas HTTP.

minLength: 1maxLength: 100

ContextMeta

localeTeaghránRiachtanach

Teanga roghnaithe don iarratas seo.

market_codeTeaghránRiachtanach

Cód margaidh a thugann an críochphointe comhthéacs.

market_idTeaghránRiachtanach

Aitheantóir margaidh a thugann an críochphointe comhthéacs.

request_idTeaghránRiachtanach

Aitheantóir iarratais; i meiteashonraí freagra aithníonn sé an t-iarratas HTTP.

minLength: 1maxLength: 100

PageMeta

paginationPagination Riachtanach

Meiteashonraí leathanaithe le cúrsóir.

request_idTeaghránRiachtanach

Aitheantóir iarratais; i meiteashonraí freagra aithníonn sé an t-iarratas HTTP.

minLength: 1maxLength: 100

RequestMeta

request_idTeaghránRiachtanach

Aitheantóir iarratais; i meiteashonraí freagra aithníonn sé an t-iarratas HTTP.

minLength: 1maxLength: 100
Sampla freagra

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ánRoghnach

An scéim fíordheimhnithe a éilíonn an freastalaí.

405

AllowTeaghránRoghnach

Modhanna HTTP a thacaíonn an acmhainn seo leo.

429, 503

Retry-AfterSlánuimhirRoghnach

An mhoill íosta roimh atriail, i soicindí.

minimum: 0