Dohvati — Narudžbe

Pročitajte podatke iz „Narudžbe“. Rezultat ovisi o parametrima ove radnje.

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

Autentifikacija: Bearer
Dostupno od: BASIC
Potrebne ovlasti: orders.order:read

Primjer zahtjeva

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

Primjer 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 funkcionira

Zbirka pruža sažetke narudžbi i filtre za broj, status, status plaćanja i vrijeme izrade.
Popis i pojedinosti narudžbe sadrže delivery.dates. Planirani datumi YYYY-MM-DD ne potvrđuju otpremu. Trenutačni datumi imaju prednost; starije narudžbe koriste spremljenu procjenu. Izbrisane ili nepoznate vrijednosti su null. Pojedinosti sadrže i sve stavke i slike proizvoda.

Valjane identifikatore statusa dohvatite s /api/v1/order-statuses.
Status narudžbe i status plaćanja koriste zasebne PATCH krajnje točke i ovlasti.
Promjena evidentiranog statusa plaćanja ne tereti karticu niti izvršava povrat preko pružatelja platnih usluga.

Sigurni upisi

Ovlasti i planovi

Narudžba · Ukupni iznosi

Iznosi i stope dolaze iz spremljene narudžbe, uključujući ispravke stavki. Nepoznati povijesni podaci su null i ne zamjenjuju se trenutačnim stopama iz kataloga. Iznosi ostaju decimalni nizovi.

Popis vraća sažetke. Za svaki rezultat dohvatite GET /api/v1/orders/{order_id} za potpune financijske podatke. Ponavljanja GET ograničena su i poštuju Retry-After. Izvoz po datumu izrade ne sinkronizira kasnije ispravke.

tax_country_code · Porezna država · Spremljeni podaci narudžbe · ISO 3166-1 alpha-2; null.
lines[].unit_* · Jedna jedinica · Prije popusta; lines[].original_total_* · Prije popusta; lines[].total_* · Nakon popusta.
lines[].discount_* · Popusti; manual_discount · Ručni popust; percentage "10" = 10%.
delivery.net / tax / gross · Nakon popusta; delivery.original_* · Prije popusta; delivery.discount_* · Popusti.
tax_rate: "0.23" = 23%; "0" ≠ null. Nepoznato: null; poznata nula: 0.
totals · Ukupni iznosi; tax_breakdown.groups · Porezne skupine; Neraspoređeni porez = order.tax − Σ groups.tax; ±.

payment.amount je ukupni iznos narudžbe. Status plaćanja ne određuje plaćene, vraćene ili nepodmirene iznose.

Parametri

Parametri putanje

order_idNiz znakovaObvezno

Identifikator povezane narudžbe.

Ograničenja

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

Primjer: "example"

Ova operacija ne prihvaća JSON tijelo.

Odgovori

Odgovor 200

Cijeli model: ApiResponse_OrderDetailData_

dataOrderDetailData Obvezno

Podaci uspješnog odgovora.

Polja · data

Cijeli model: OrderDetailData

created_atNiz znakovaObvezno

Vrijeme izrade.

format: "date-time"

customerCustomerData Obvezno

Podaci kupca zabilježeni za ovaj resurs.

Polja · customer

Cijeli model: CustomerData

emailNiz znakovaObvezno: Adresa e-pošte.
first_nameNiz znakova nullObvezno: Ime.
last_nameNiz znakova nullObvezno: Prezime.
phoneNiz znakova nullObvezno: Telefonski broj.

deliveryShippingDetailData Obvezno

Način dostave i povezani podaci.

Polja · delivery

Cijeli model: ShippingDetailData

amountMoneyData Obvezno

Decimalni iznos kodiran kao JSON niz znakova; null samo gdje je dopušten.

datesDeliveryDatesData Obvezno

Datumi otpreme i dostave

discount_grossMoneyData Obvezno

Bruto iznos · Popusti; Nepoznato: null; poznata nula: 0.

discount_netMoneyData nullObvezno

Neto iznos · Popusti; Nepoznato: null; poznata nula: 0.

discount_taxMoneyData nullObvezno

Iznos poreza · Popusti; Nepoznato: null; poznata nula: 0.

discountsPolje vrijednosti <OrderDeliveryDiscountData > nullObvezno

Popusti

grossMoneyData Obvezno

Bruto iznos · Nakon popusta; Nepoznato: null; poznata nula: 0.

method_codeNiz znakova nullObvezno

Kod načina dostave ili plaćanja.

method_nameNiz znakova nullObvezno

Naziv načina dostave ili plaćanja.

netMoneyData nullObvezno

Neto iznos · Nakon popusta; Nepoznato: null; poznata nula: 0.

original_grossMoneyData Obvezno

Bruto iznos · Dostava · Prije popusta; Nepoznato: null; poznata nula: 0.

original_netMoneyData nullObvezno

Neto iznos · Dostava · Prije popusta; Nepoznato: null; poznata nula: 0.

original_taxMoneyData nullObvezno

Iznos poreza · Dostava · Prije popusta; Nepoznato: null; poznata nula: 0.

pickup_pointDeliveryPickupPointData nullObvezno

Mjesto preuzimanja

recipient_modeNiz znakovaObvezno

Varijanta strukture podataka opisana dopuštenim vrijednostima.

Ograničenja

enum: ["full_address", "pickup_contact"]

taxMoneyData nullObvezno

Porezni podaci.

tax_category_idNiz znakova nullObvezno

Identifikator porezne kategorije.

tax_category_nameNiz znakova nullObvezno

Spremljeni naziv porezne kategorije; null.

tax_rateNiz znakova nullObvezno

tax_rate · Spremljeni podaci narudžbe: "0.23" = 23%; "0" ≠ null.

discount_amountMoneyData Obvezno

Decimalni iznos kodiran kao JSON niz znakova; null samo gdje je dopušten.

Polja · discount_amount

Cijeli model: MoneyData

amountNiz znakovaObvezno

Decimalni iznos kodiran kao JSON niz znakova; null samo gdje je dopušten.

currencyNiz znakovaObvezno

Kod valute iznosa.

Ograničenja

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

minor_unitsCijeli brojObvezno

Broj decimalnih znamenki valute.

minimum: 0maximum: 4

discountsPolje vrijednosti <OrderDiscountData > Obvezno

Popusti

Polja · discounts

OrderDiscountData

Cijeli model: OrderDiscountData

idNiz znakovaObvezno

Identifikator resursa; sačuvajte ga u vraćenom obliku.

invoiceInvoiceData nullObvezno

Podaci računa.

Polja · invoice

InvoiceData

Cijeli model: InvoiceData

null

invoice_requestedLogička vrijednostObvezno

Je li zatražen račun.

lifecycle_stateOrderLifecycleState Obvezno

Stanje poslovnog životnog ciklusa.

linesPolje vrijednosti <OrderLineData > Obvezno

Snimke stanja stavki narudžbe.

Polja · lines

OrderLineData

Cijeli model: OrderLineData

localeNiz znakovaObvezno

Jezik odabran za ovaj zahtjev.

market_idNiz znakovaObvezno

Identifikator tržišta vraćen s krajnje točke konteksta.

numberNiz znakovaObvezno

Broj narudžbe ili zahtjeva namijenjen korisniku.

paymentPaymentData Obvezno

Podaci o plaćanju zabilježeni za narudžbu.

Polja · payment

Cijeli model: PaymentData

amountMoneyData Obvezno

Decimalni iznos kodiran kao JSON niz znakova; null samo gdje je dopušten.

environmentNiz znakovaObvezno

Podaci o okruženju pridruženi zapisu.

Ograničenja

enum: ["live", "sandbox"]

method_codeNiz znakova nullObvezno

Kod načina dostave ili plaćanja.

method_nameNiz znakova nullObvezno

Naziv načina dostave ili plaćanja.

paid_atNiz znakova nullObvezno

Datum i vrijeme kada je plaćanje označeno kao plaćeno.

Niz znakova:format: "date-time"

statusOrderPaymentStatus Obvezno

Status prihvaćen za ovu određenu operaciju.

updated_atNiz znakovaObvezno

Vrijeme posljednjeg ažuriranja.

format: "date-time"

versionCijeli brojObvezno

Verzija resursa za kontrolu istodobnih upisa.

pickup_pointPickupPointData nullObvezno

Mjesto preuzimanja

Polja · pickup_point

PickupPointData

Cijeli model: PickupPointData

null

prices_include_taxLogička vrijednostObvezno

Uključuju li navedene cijene porez.

shipping_addressAddressData nullObvezno

Adresa dostave.

Polja · shipping_address

AddressData

Cijeli model: AddressData

null

shipping_discount_amountMoneyData Obvezno

Decimalni iznos kodiran kao JSON niz znakova; null samo gdje je dopušten.

Polja · shipping_discount_amount

Cijeli model: MoneyData

amountNiz znakovaObvezno

Decimalni iznos kodiran kao JSON niz znakova; null samo gdje je dopušten.

currencyNiz znakovaObvezno

Kod valute iznosa.

Ograničenja

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

minor_unitsCijeli brojObvezno

Broj decimalnih znamenki valute.

minimum: 0maximum: 4

statusOrderStatusData Obvezno

Status prihvaćen za ovu određenu operaciju.

Polja · status

Cijeli model: OrderStatusData

idNiz znakovaObvezno: Identifikator resursa; sačuvajte ga u vraćenom obliku.
nameNiz znakovaObvezno: Naziv resursa u odgovarajućem kontekstu.
updated_atNiz znakovaObvezno: Vrijeme posljednjeg ažuriranja.
format: "date-time"
versionCijeli brojObvezno: Verzija resursa za kontrolu istodobnih upisa.

subtotalMoneyData Obvezno

Iznos prije dodatnih sastavnica prikazanih u odgovoru.

Polja · subtotal

Cijeli model: MoneyData

amountNiz znakovaObvezno

Decimalni iznos kodiran kao JSON niz znakova; null samo gdje je dopušten.

currencyNiz znakovaObvezno

Kod valute iznosa.

Ograničenja

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

minor_unitsCijeli brojObvezno

Broj decimalnih znamenki valute.

minimum: 0maximum: 4

taxMoneyData Obvezno

Porezni podaci.

Polja · tax

Cijeli model: MoneyData

amountNiz znakovaObvezno

Decimalni iznos kodiran kao JSON niz znakova; null samo gdje je dopušten.

currencyNiz znakovaObvezno

Kod valute iznosa.

Ograničenja

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

minor_unitsCijeli brojObvezno

Broj decimalnih znamenki valute.

minimum: 0maximum: 4

tax_breakdownOrderTaxBreakdownData Obvezno

Porezne skupine · source + tax_rate; unallocated_tax.

Polja · tax_breakdown

Cijeli model: OrderTaxBreakdownData

groupsPolje vrijednosti <OrderTaxGroupData > Obvezno: Porezne skupine · source + tax_rate; Nepoznato: null; poznata nula: 0.
unallocated_taxMoneyData Obvezno: Neraspoređeni porez = order.tax − Σ groups.tax; ±.

tax_country_codeNiz znakova nullObvezno

Porezna država · Spremljeni podaci narudžbe · ISO 3166-1 alpha-2; null.

totalMoneyData Obvezno

Ukupan iznos.

Polja · total

Cijeli model: MoneyData

amountNiz znakovaObvezno

Decimalni iznos kodiran kao JSON niz znakova; null samo gdje je dopušten.

currencyNiz znakovaObvezno

Kod valute iznosa.

Ograničenja

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

minor_unitsCijeli brojObvezno

Broj decimalnih znamenki valute.

minimum: 0maximum: 4

totalsOrderTotalsData Obvezno

Ukupni iznosi · net / tax / gross; Prije popusta / Nakon popusta.

Polja · totals

Cijeli model: OrderTotalsData

before_discountsOrderAmountBreakdownData Obvezno: Narudžba · Prije popusta · net / tax / gross.
discountsOrderAmountBreakdownData Obvezno: Popusti
orderOrderAmountBreakdownData Obvezno: Narudžba · Nakon popusta · net / tax / gross.
product_discountsOrderAmountBreakdownData Obvezno: Proizvodi · Popusti · net / tax / gross.
productsOrderAmountBreakdownData Obvezno: Proizvodi · Nakon popusta · net / tax / gross.
products_before_discountsOrderAmountBreakdownData Obvezno: Proizvodi · Prije popusta · net / tax / gross.
shippingOrderAmountBreakdownData Obvezno: Dostava · Nakon popusta · net / tax / gross.
shipping_before_discountsOrderAmountBreakdownData Obvezno: Dostava · Prije popusta · net / tax / gross.
shipping_discountsOrderAmountBreakdownData Obvezno: Dostava · Popusti · net / tax / gross.

metaContextPageMeta ContextMeta PageMeta RequestMeta Obvezno

Metapodaci odgovora.

Polja · meta

ContextPageMeta

Cijeli model: ContextPageMeta

localeNiz znakovaObvezno: Jezik odabran za ovaj zahtjev.
market_codeNiz znakovaObvezno: Kod tržišta vraćen s krajnje točke konteksta.
market_idNiz znakovaObvezno: Identifikator tržišta vraćen s krajnje točke konteksta.
paginationPagination Obvezno: Metapodaci straničenja pomoću kursora.
request_idNiz znakovaObvezno: Identifikator zahtjeva; u metapodacima odgovora označava HTTP zahtjev.
minLength: 1maxLength: 100

ContextMeta

Cijeli model: ContextMeta

localeNiz znakovaObvezno: Jezik odabran za ovaj zahtjev.
market_codeNiz znakovaObvezno: Kod tržišta vraćen s krajnje točke konteksta.
market_idNiz znakovaObvezno: Identifikator tržišta vraćen s krajnje točke konteksta.
request_idNiz znakovaObvezno: Identifikator zahtjeva; u metapodacima odgovora označava HTTP zahtjev.
minLength: 1maxLength: 100

PageMeta

Cijeli model: PageMeta

paginationPagination Obvezno: Metapodaci straničenja pomoću kursora.
request_idNiz znakovaObvezno: Identifikator zahtjeva; u metapodacima odgovora označava HTTP zahtjev.
minLength: 1maxLength: 100

RequestMeta

Cijeli model: RequestMeta

request_idNiz znakovaObvezno: Identifikator zahtjeva; u metapodacima odgovora označava HTTP zahtjev.
minLength: 1maxLength: 100

Primjer odgovora

HTTP status

200: Uspješan odgovor Shema
400: Nevaljan zahtjev
401: Potrebna je autentikacija
403: Pristup odbijen
404: Resurs nije pronađen
409: Sukob verzija
422: Provjera nije uspjela
429: Prekoračeno ograničenje zahtjeva

Ostali HTTP statusi (7)

405: Metoda nije dopuštena
413: Zahtjev je prevelik
415: Nepodržan format
500: Pogreška poslužitelja
502: Pogreška API pristupnika
503: Usluga nije dostupna
504: Istek vremena

Katalog pogrešaka: ErrorResponse

Zaglavlja

401

WWW-AuthenticateNiz znakovaNeobavezno: Shema autentifikacije koju zahtijeva poslužitelj.

405

AllowNiz znakovaNeobavezno: HTTP metode koje ovaj resurs podržava.

429, 503

Retry-AfterCijeli brojNeobavezno: Najkraće čekanje prije ponavljanja, u sekundama.

minimum: 0

Katalog pogrešaka · Saznajte više

GET/api/v1/orders/{order_id}

Primjeri koda

Primjer zahtjeva

cURL

PHP

Python

Primjer odgovora 200

Kako funkcionira

Narudžba · Ukupni iznosi

Parametri

Parametri putanje

Odgovori

Odgovor 200

HTTP status

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