Pridobi — Naročila

Preberite podatke iz »Naročila«. Rezultat je odvisen od parametrov tega dejanja.

GET`/api/v1/orders/{order_id}`

Preverjanje pristnosti: Bearer
Na voljo od paketa: BASIC
Zahtevana dovoljenja: orders.order:read

Primer zahteve

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

Primer odgovora 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"
      },
      "discount_gross": {
        "amount": "24.60",
        "currency": "PLN",
        "minor_units": 2
      },
      "discount_net": {
        "amount": "20.00",
        "currency": "PLN",
        "minor_units": 2
      },
      "discount_tax": {
        "amount": "4.60",
        "currency": "PLN",
        "minor_units": 2
      },
      "discounts": [
        {
          "amount": {
            "amount": "24.60",
            "currency": "PLN",
            "minor_units": 2
          },
          "campaign_id": "saved-coupon",
          "code": "SAVE",
          "kind": "coupon",
          "name": "Saved coupon",
          "sequence": 1,
          "version": 3
        }
      ],
      "gross": {
        "amount": "0.00",
        "currency": "PLN",
        "minor_units": 2
      },
      "method_code": "shipping-old",
      "method_name": "Historic carrier",
      "net": {
        "amount": "0.00",
        "currency": "PLN",
        "minor_units": 2
      },
      "original_gross": {
        "amount": "24.60",
        "currency": "PLN",
        "minor_units": 2
      },
      "original_net": {
        "amount": "20.00",
        "currency": "PLN",
        "minor_units": 2
      },
      "original_tax": {
        "amount": "4.60",
        "currency": "PLN",
        "minor_units": 2
      },
      "pickup_point": null,
      "recipient_mode": "full_address",
      "tax": {
        "amount": "0.00",
        "currency": "PLN",
        "minor_units": 2
      },
      "tax_category_id": "standard",
      "tax_category_name": "VAT 23%",
      "tax_rate": "0.23"
    },
    "discount_amount": {
      "amount": "24.60",
      "currency": "PLN",
      "minor_units": 2
    },
    "discounts": [
      {
        "amount": {
          "amount": "12.30",
          "currency": "PLN",
          "minor_units": 2
        },
        "campaign_id": "saved-coupon",
        "code": "SAVE",
        "kind": "coupon",
        "name": "Saved coupon",
        "sequence": 1,
        "shipping_amount": {
          "amount": "24.60",
          "currency": "PLN",
          "minor_units": 2
        },
        "version": 3
      }
    ],
    "id": "order-0000",
    "invoice": null,
    "invoice_requested": false,
    "lifecycle_state": "placed",
    "lines": [
      {
        "discount_amount": {
          "amount": "24.60",
          "currency": "PLN",
          "minor_units": 2
        },
        "discount_gross": {
          "amount": "24.60",
          "currency": "PLN",
          "minor_units": 2
        },
        "discount_net": {
          "amount": "20.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "discount_tax": {
          "amount": "4.60",
          "currency": "PLN",
          "minor_units": 2
        },
        "discounts": [
          {
            "amount": {
              "amount": "12.30",
              "currency": "PLN",
              "minor_units": 2
            },
            "campaign_id": "saved-coupon",
            "code": "SAVE",
            "kind": "coupon",
            "name": "Saved coupon",
            "sequence": 1,
            "shipping_amount": null,
            "version": 3
          }
        ],
        "identifiers": {},
        "image": null,
        "line_id": "saved-line-a",
        "manual_discount": {
          "amount": {
            "amount": "12.30",
            "currency": "PLN",
            "minor_units": 2
          },
          "kind": "fixed",
          "value": "12.30"
        },
        "name": "Saved A",
        "original_total": {
          "amount": "246.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "original_total_gross": {
          "amount": "246.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "original_total_net": {
          "amount": "200.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "original_total_tax": {
          "amount": "46.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "position": 1,
        "product_id": "product-api",
        "quantity": 2,
        "sku": "A",
        "tax": {
          "amount": "20.70",
          "currency": "PLN",
          "minor_units": 2
        },
        "tax_category_id": "standard",
        "tax_category_name": "VAT 23%",
        "tax_rate": "0.23",
        "total": {
          "amount": "221.40",
          "currency": "PLN",
          "minor_units": 2
        },
        "total_gross": {
          "amount": "221.40",
          "currency": "PLN",
          "minor_units": 2
        },
        "total_net": {
          "amount": "180.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "total_tax": {
          "amount": "41.40",
          "currency": "PLN",
          "minor_units": 2
        },
        "unit_gross": {
          "amount": "123.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "unit_net": {
          "amount": "100.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "unit_price": {
          "amount": "123.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "unit_tax": {
          "amount": "23.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "variant_id": null,
        "variant_options": []
      },
      {
        "discount_amount": {
          "amount": "0.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "discount_gross": {
          "amount": "0.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "discount_net": {
          "amount": "0.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "discount_tax": {
          "amount": "0.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "discounts": [],
        "identifiers": {},
        "image": null,
        "line_id": "b548a171-c331-505f-98f8-db3a06070998",
        "manual_discount": null,
        "name": "Saved B",
        "original_total": {
          "amount": "108.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "original_total_gross": {
          "amount": "108.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "original_total_net": {
          "amount": "100.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "original_total_tax": {
          "amount": "8.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "position": 2,
        "product_id": "deleted-product",
        "quantity": 1,
        "sku": "B",
        "tax": null,
        "tax_category_id": "reduced",
        "tax_category_name": "VAT 8%",
        "tax_rate": "0.08",
        "total": {
          "amount": "108.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "total_gross": {
          "amount": "108.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "total_net": {
          "amount": "100.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "total_tax": {
          "amount": "8.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "unit_gross": {
          "amount": "108.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "unit_net": {
          "amount": "100.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "unit_price": {
          "amount": "108.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "unit_tax": {
          "amount": "8.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "variant_id": null,
        "variant_options": []
      }
    ],
    "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
    },
    "pickup_point": null,
    "prices_include_tax": true,
    "shipping_address": null,
    "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_breakdown": {
      "groups": [
        {
          "gross": {
            "amount": "221.40",
            "currency": "PLN",
            "minor_units": 2
          },
          "net": {
            "amount": "180.00",
            "currency": "PLN",
            "minor_units": 2
          },
          "source": "products",
          "tax": {
            "amount": "41.40",
            "currency": "PLN",
            "minor_units": 2
          },
          "tax_rate": "0.23"
        },
        {
          "gross": {
            "amount": "108.00",
            "currency": "PLN",
            "minor_units": 2
          },
          "net": {
            "amount": "100.00",
            "currency": "PLN",
            "minor_units": 2
          },
          "source": "products",
          "tax": {
            "amount": "8.00",
            "currency": "PLN",
            "minor_units": 2
          },
          "tax_rate": "0.08"
        },
        {
          "gross": {
            "amount": "0.00",
            "currency": "PLN",
            "minor_units": 2
          },
          "net": {
            "amount": "0.00",
            "currency": "PLN",
            "minor_units": 2
          },
          "source": "shipping",
          "tax": {
            "amount": "0.00",
            "currency": "PLN",
            "minor_units": 2
          },
          "tax_rate": "0.23"
        }
      ],
      "unallocated_tax": {
        "amount": "0.00",
        "currency": "PLN",
        "minor_units": 2
      }
    },
    "tax_country_code": "PL",
    "total": {
      "amount": "329.40",
      "currency": "PLN",
      "minor_units": 2
    },
    "totals": {
      "before_discounts": {
        "gross": {
          "amount": "378.60",
          "currency": "PLN",
          "minor_units": 2
        },
        "net": {
          "amount": "320.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "tax": {
          "amount": "58.60",
          "currency": "PLN",
          "minor_units": 2
        }
      },
      "discounts": {
        "gross": {
          "amount": "49.20",
          "currency": "PLN",
          "minor_units": 2
        },
        "net": {
          "amount": "40.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "tax": {
          "amount": "9.20",
          "currency": "PLN",
          "minor_units": 2
        }
      },
      "order": {
        "gross": {
          "amount": "329.40",
          "currency": "PLN",
          "minor_units": 2
        },
        "net": {
          "amount": "280.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "tax": {
          "amount": "49.40",
          "currency": "PLN",
          "minor_units": 2
        }
      },
      "product_discounts": {
        "gross": {
          "amount": "24.60",
          "currency": "PLN",
          "minor_units": 2
        },
        "net": {
          "amount": "20.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "tax": {
          "amount": "4.60",
          "currency": "PLN",
          "minor_units": 2
        }
      },
      "products": {
        "gross": {
          "amount": "329.40",
          "currency": "PLN",
          "minor_units": 2
        },
        "net": {
          "amount": "280.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "tax": {
          "amount": "49.40",
          "currency": "PLN",
          "minor_units": 2
        }
      },
      "products_before_discounts": {
        "gross": {
          "amount": "354.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "net": {
          "amount": "300.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "tax": {
          "amount": "54.00",
          "currency": "PLN",
          "minor_units": 2
        }
      },
      "shipping": {
        "gross": {
          "amount": "0.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "net": {
          "amount": "0.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "tax": {
          "amount": "0.00",
          "currency": "PLN",
          "minor_units": 2
        }
      },
      "shipping_before_discounts": {
        "gross": {
          "amount": "24.60",
          "currency": "PLN",
          "minor_units": 2
        },
        "net": {
          "amount": "20.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "tax": {
          "amount": "4.60",
          "currency": "PLN",
          "minor_units": 2
        }
      },
      "shipping_discounts": {
        "gross": {
          "amount": "24.60",
          "currency": "PLN",
          "minor_units": 2
        },
        "net": {
          "amount": "20.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "tax": {
          "amount": "4.60",
          "currency": "PLN",
          "minor_units": 2
        }
      }
    }
  },
  "meta": {
    "request_id": "example-request"
  }
}

Kako deluje

Zbirka vsebuje povzetke naročil in filtre po številki, statusu, plačilnem statusu in času nastanka.
Seznam in podrobnosti naročila vsebujejo delivery.dates. Načrtovani datumi YYYY-MM-DD ne potrjujejo odpreme. Trenutni datumi imajo prednost; starejša naročila uporabljajo shranjeno oceno. Izbrisane ali neznane vrednosti so null. Podrobnosti vsebujejo tudi vse postavke in slike izdelkov.

Veljavne identifikatorje statusov pridobite iz /api/v1/order-statuses.
Status naročila in plačila uporabljata ločeni končni točki PATCH in dovoljenja.
Sprememba zabeleženega plačilnega statusa ne bremeni kartice in ne izvede vračila pri ponudniku plačil.

Varni zapisi

Dovoljenja in paketi

Naročilo · Skupni zneski

Zneski in stopnje izvirajo iz shranjenega naročila, vključno s popravki postavk. Manjkajoči pretekli podatki so null in se ne nadomestijo s trenutnimi stopnjami kataloga. Zneski ostanejo decimalni nizi.

Seznam vrne povzetke. Za vsak rezultat pridobite GET /api/v1/orders/{order_id} za popolne finančne podatke. Ponovitve GET so omejene in upoštevajo Retry-After. Izvoz po datumu nastanka ne sinhronizira poznejših popravkov.

tax_country_code · Davčna država · Shranjeni podatki naročila · ISO 3166-1 alpha-2; null.
lines[].unit_* · Ena enota · Pred popusti; lines[].original_total_* · Pred popusti; lines[].total_* · Po popustih.
lines[].discount_* · Popusti; manual_discount · Ročni popust; percentage "10" = 10%.
delivery.net / tax / gross · Po popustih; delivery.original_* · Pred popusti; delivery.discount_* · Popusti.
tax_rate: "0.23" = 23%; "0" ≠ null. Neznano: null; znana ničla: 0.
totals · Skupni zneski; tax_breakdown.groups · Davčne skupine; Nerazporejen davek = order.tax − Σ groups.tax; ±.

payment.amount je skupni znesek naročila. Stanje plačila ne določa plačanih, vrnjenih ali dolgovanih zneskov.

Parametri

Parametri poti

order_idNizObvezno

Identifikator povezanega naročila.

Omejitve

pattern: "^[a-z0-9][a-z0-9_-]{0,62}$"

Primer: "example"

Ta operacija ne sprejema telesa JSON.

Odgovori

Odgovor 200

Celoten model: ApiResponse_OrderDetailData_

dataOrderDetailData Obvezno

Vsebina uspešnega odgovora.

Polja · data

Celoten model: OrderDetailData

created_atNizObvezno

Čas nastanka.

format: "date-time"

customerCustomerData Obvezno

Podatki stranke, zabeleženi za ta vir.

Polja · customer

Celoten model: CustomerData

emailNizObvezno: E-poštni naslov.
first_nameNiz nullObvezno: Ime.
last_nameNiz nullObvezno: Priimek.
phoneNiz nullObvezno: Telefonska številka.

deliveryShippingDetailData Obvezno

Način dostave in povezani podatki.

Polja · delivery

Celoten model: ShippingDetailData

amountMoneyData Obvezno

Decimalni znesek, kodiran kot niz JSON; null le tam, kjer je dovoljen.

datesDeliveryDatesData Obvezno

Datumi odpreme in dostave

discount_grossMoneyData Obvezno

Bruto znesek · Popusti; Neznano: null; znana ničla: 0.

discount_netMoneyData nullObvezno

Neto znesek · Popusti; Neznano: null; znana ničla: 0.

discount_taxMoneyData nullObvezno

Znesek davka · Popusti; Neznano: null; znana ničla: 0.

discountsPolje elementov <OrderDeliveryDiscountData > nullObvezno

Popusti

grossMoneyData Obvezno

Bruto znesek · Po popustih; Neznano: null; znana ničla: 0.

method_codeNiz nullObvezno

Koda načina dostave ali plačila.

method_nameNiz nullObvezno

Ime načina dostave ali plačila.

netMoneyData nullObvezno

Neto znesek · Po popustih; Neznano: null; znana ničla: 0.

original_grossMoneyData Obvezno

Bruto znesek · Dostava · Pred popusti; Neznano: null; znana ničla: 0.

original_netMoneyData nullObvezno

Neto znesek · Dostava · Pred popusti; Neznano: null; znana ničla: 0.

original_taxMoneyData nullObvezno

Znesek davka · Dostava · Pred popusti; Neznano: null; znana ničla: 0.

pickup_pointDeliveryPickupPointData nullObvezno

Prevzemno mesto

recipient_modeNizObvezno

Vrsta podatkovne strukture, opisana z dovoljenimi vrednostmi.

Omejitve

enum: ["full_address", "pickup_contact"]

taxMoneyData nullObvezno

Davčni podatki.

tax_category_idNiz nullObvezno

Identifikator davčne kategorije.

tax_category_nameNiz nullObvezno

Shranjeno ime davčne kategorije; null.

tax_rateNiz nullObvezno

tax_rate · Shranjeni podatki naročila: "0.23" = 23%; "0" ≠ null.

discount_amountMoneyData Obvezno

Decimalni znesek, kodiran kot niz JSON; null le tam, kjer je dovoljen.

Polja · discount_amount

Celoten model: MoneyData

amountNizObvezno

Decimalni znesek, kodiran kot niz JSON; null le tam, kjer je dovoljen.

currencyNizObvezno

Koda valute zneska.

Omejitve

pattern: "^[A-Z]{3}$"

minor_unitsCelo številoObvezno

Število decimalnih mest valute.

minimum: 0maximum: 4

discountsPolje elementov <OrderDiscountData > Obvezno

Popusti

Polja · discounts

OrderDiscountData

Celoten model: OrderDiscountData

idNizObvezno

Identifikator vira; ohranite ga v vrnjeni obliki.

invoiceInvoiceData nullObvezno

Podatki računa.

Polja · invoice

InvoiceData

Celoten model: InvoiceData

null

invoice_requestedLogična vrednostObvezno

Ali je bil zahtevan račun.

lifecycle_stateOrderLifecycleState Obvezno

Stanje poslovnega življenjskega cikla.

linesPolje elementov <OrderLineData > Obvezno

Posnetki postavk naročila.

Polja · lines

OrderLineData

Celoten model: OrderLineData

localeNizObvezno

Jezik, izbran za to zahtevo.

market_idNizObvezno

Identifikator trga, vrnjen s končno točko konteksta.

numberNizObvezno

Uporabniku prikazana številka naročila ali zahtevka.

paymentPaymentData Obvezno

Podrobnosti plačila, zabeležene za naročilo.

Polja · payment

Celoten model: PaymentData

amountMoneyData Obvezno

Decimalni znesek, kodiran kot niz JSON; null le tam, kjer je dovoljen.

environmentNizObvezno

Podatki o okolju, dodani zapisu.

Omejitve

enum: ["live", "sandbox"]

method_codeNiz nullObvezno

Koda načina dostave ali plačila.

method_nameNiz nullObvezno

Ime načina dostave ali plačila.

paid_atNiz nullObvezno

Datum in čas, ko je bilo plačilo označeno kot plačano.

Niz:format: "date-time"

statusOrderPaymentStatus Obvezno

Status, ki ga sprejema ta operacija.

updated_atNizObvezno

Čas zadnje posodobitve.

format: "date-time"

versionCelo številoObvezno

Različica vira za nadzor sočasnosti.

pickup_pointPickupPointData nullObvezno

Prevzemno mesto

Polja · pickup_point

PickupPointData

Celoten model: PickupPointData

null

prices_include_taxLogična vrednostObvezno

Ali navedene cene vključujejo davek.

shipping_addressAddressData nullObvezno

Naslov za dostavo.

Polja · shipping_address

AddressData

Celoten model: AddressData

null

shipping_discount_amountMoneyData Obvezno

Decimalni znesek, kodiran kot niz JSON; null le tam, kjer je dovoljen.

Polja · shipping_discount_amount

Celoten model: MoneyData

amountNizObvezno

Decimalni znesek, kodiran kot niz JSON; null le tam, kjer je dovoljen.

currencyNizObvezno

Koda valute zneska.

Omejitve

pattern: "^[A-Z]{3}$"

minor_unitsCelo številoObvezno

Število decimalnih mest valute.

minimum: 0maximum: 4

statusOrderStatusData Obvezno

Status, ki ga sprejema ta operacija.

Polja · status

Celoten model: OrderStatusData

idNizObvezno: Identifikator vira; ohranite ga v vrnjeni obliki.
nameNizObvezno: Ime vira v ustreznem kontekstu.
updated_atNizObvezno: Čas zadnje posodobitve.
format: "date-time"
versionCelo številoObvezno: Različica vira za nadzor sočasnosti.

subtotalMoneyData Obvezno

Znesek pred dodatnimi postavkami, prikazanimi v odgovoru.

Polja · subtotal

Celoten model: MoneyData

amountNizObvezno

Decimalni znesek, kodiran kot niz JSON; null le tam, kjer je dovoljen.

currencyNizObvezno

Koda valute zneska.

Omejitve

pattern: "^[A-Z]{3}$"

minor_unitsCelo številoObvezno

Število decimalnih mest valute.

minimum: 0maximum: 4

taxMoneyData Obvezno

Davčni podatki.

Polja · tax

Celoten model: MoneyData

amountNizObvezno

Decimalni znesek, kodiran kot niz JSON; null le tam, kjer je dovoljen.

currencyNizObvezno

Koda valute zneska.

Omejitve

pattern: "^[A-Z]{3}$"

minor_unitsCelo številoObvezno

Število decimalnih mest valute.

minimum: 0maximum: 4

tax_breakdownOrderTaxBreakdownData Obvezno

Davčne skupine · source + tax_rate; unallocated_tax.

Polja · tax_breakdown

Celoten model: OrderTaxBreakdownData

groupsPolje elementov <OrderTaxGroupData > Obvezno: Davčne skupine · source + tax_rate; Neznano: null; znana ničla: 0.
unallocated_taxMoneyData Obvezno: Nerazporejen davek = order.tax − Σ groups.tax; ±.

tax_country_codeNiz nullObvezno

Davčna država · Shranjeni podatki naročila · ISO 3166-1 alpha-2; null.

totalMoneyData Obvezno

Skupni znesek.

Polja · total

Celoten model: MoneyData

amountNizObvezno

Decimalni znesek, kodiran kot niz JSON; null le tam, kjer je dovoljen.

currencyNizObvezno

Koda valute zneska.

Omejitve

pattern: "^[A-Z]{3}$"

minor_unitsCelo številoObvezno

Število decimalnih mest valute.

minimum: 0maximum: 4

totalsOrderTotalsData Obvezno

Skupni zneski · net / tax / gross; Pred popusti / Po popustih.

Polja · totals

Celoten model: OrderTotalsData

before_discountsOrderAmountBreakdownData Obvezno: Naročilo · Pred popusti · net / tax / gross.
discountsOrderAmountBreakdownData Obvezno: Popusti
orderOrderAmountBreakdownData Obvezno: Naročilo · Po popustih · net / tax / gross.
product_discountsOrderAmountBreakdownData Obvezno: Izdelki · Popusti · net / tax / gross.
productsOrderAmountBreakdownData Obvezno: Izdelki · Po popustih · net / tax / gross.
products_before_discountsOrderAmountBreakdownData Obvezno: Izdelki · Pred popusti · net / tax / gross.
shippingOrderAmountBreakdownData Obvezno: Dostava · Po popustih · net / tax / gross.
shipping_before_discountsOrderAmountBreakdownData Obvezno: Dostava · Pred popusti · net / tax / gross.
shipping_discountsOrderAmountBreakdownData Obvezno: Dostava · Popusti · net / tax / gross.

metaContextPageMeta ContextMeta PageMeta RequestMeta Obvezno

Metapodatki odgovora.

Polja · meta

ContextPageMeta

Celoten model: ContextPageMeta

localeNizObvezno: Jezik, izbran za to zahtevo.
market_codeNizObvezno: Koda trga, vrnjena s končno točko konteksta.
market_idNizObvezno: Identifikator trga, vrnjen s končno točko konteksta.
paginationPagination Obvezno: Metapodatki straničenja s kazalcem.
request_idNizObvezno: Identifikator zahtevka; v metapodatkih odgovora označuje zahtevo HTTP.
minLength: 1maxLength: 100

ContextMeta

Celoten model: ContextMeta

localeNizObvezno: Jezik, izbran za to zahtevo.
market_codeNizObvezno: Koda trga, vrnjena s končno točko konteksta.
market_idNizObvezno: Identifikator trga, vrnjen s končno točko konteksta.
request_idNizObvezno: Identifikator zahtevka; v metapodatkih odgovora označuje zahtevo HTTP.
minLength: 1maxLength: 100

PageMeta

Celoten model: PageMeta

paginationPagination Obvezno: Metapodatki straničenja s kazalcem.
request_idNizObvezno: Identifikator zahtevka; v metapodatkih odgovora označuje zahtevo HTTP.
minLength: 1maxLength: 100

RequestMeta

Celoten model: RequestMeta

request_idNizObvezno: Identifikator zahtevka; v metapodatkih odgovora označuje zahtevo HTTP.
minLength: 1maxLength: 100

Primer odgovora

Status HTTP

200: Uspešen odgovor Shema
400: Neveljavna zahteva
401: Potrebna je avtentikacija
403: Dostop zavrnjen
404: Vir ni najden
409: Spor različic
422: Preverjanje ni uspelo
429: Presežena omejitev zahtev

Druga stanja HTTP (7)

405: Metoda ni dovoljena
413: Zahteva je prevelika
415: Nepodprta oblika
500: Napaka strežnika
502: Napaka prehoda API
503: Storitev ni na voljo
504: Časovna omejitev je potekla

Katalog napak: ErrorResponse

Glave

401

WWW-AuthenticateNizIzbirno: Shema preverjanja pristnosti, ki jo zahteva strežnik.

405

AllowNizIzbirno: Metode HTTP, ki jih podpira ta vir.

429, 503

Retry-AfterCelo številoIzbirno: Najkrajši zamik pred ponovitvijo v sekundah.

minimum: 0

Katalog napak · Več informacij

GET/api/v1/orders/{order_id}

Primeri kode

Primer zahteve

cURL

PHP

Python

Primer odgovora 200

Kako deluje

Naročilo · Skupni zneski

Parametri

Parametri poti

Odgovori

Odgovor 200

Status HTTP

GET`/api/v1/orders/{order_id}`