Gauti — Užsakymai

Skaitykite „Užsakymai“ duomenis. Rezultatas priklauso nuo šio veiksmo parametrų.

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

Tapatybės patvirtinimas: Bearer
Prieinama nuo plano: BASIC
Būtinos teisės: orders.order:read

Užklausos pavyzdys

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

Atsakymo pavyzdys 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"
  }
}

Kaip tai veikia

Rinkinys pateikia užsakymų santraukas ir filtrus pagal numerį, būseną, mokėjimo būseną bei sukūrimo laiką.
Užsakymų sąraše ir išsamioje informacijoje yra delivery.dates. YYYY-MM-DD datos yra planuojamos ir nepatvirtina išsiuntimo. Dabartinės datos turi pirmenybę; senesni užsakymai naudoja išsaugotą prognozę. Išvalytos arba nežinomos reikšmės yra null. Išsamioje informacijoje taip pat yra visos eilutės ir produktų vaizdai.

Galiojančius būsenų identifikatorius gaukite iš /api/v1/order-statuses.
Užsakymo ir mokėjimo būsenoms naudojami atskiri PATCH prieigos taškai bei teisės.
Pakeitus užregistruotą mokėjimo būseną, kortelė neapmokestinama ir per mokėjimų paslaugų teikėją pinigai negrąžinami.

Saugus įrašymas

Teisės ir planai

Užsakymas · Suvestinės

Sumos ir tarifai gaunami iš išsaugoto užsakymo, įskaitant eilučių pataisas. Trūkstami istoriniai duomenys yra null ir nepakeičiami dabartiniais katalogo tarifais. Sumos lieka dešimtainėmis eilutėmis.

Sąrašas grąžina suvestines. Kiekvienam rezultatui gaukite GET /api/v1/orders/{order_id}, kad eksportuotumėte visus finansinius duomenis. GET kartojimai riboti ir paiso Retry-After. Eksportas pagal sukūrimo datą nesinchronizuoja vėlesnių pataisų.

tax_country_code · Apmokestinimo šalis · Išsaugoti užsakymo duomenys · ISO 3166-1 alpha-2; null.
lines[].unit_* · Vienas vienetas · Prieš nuolaidas; lines[].original_total_* · Prieš nuolaidas; lines[].total_* · Po nuolaidų.
lines[].discount_* · Nuolaidos; manual_discount · Rankinė nuolaida; percentage "10" = 10%.
delivery.net / tax / gross · Po nuolaidų; delivery.original_* · Prieš nuolaidas; delivery.discount_* · Nuolaidos.
tax_rate: "0.23" = 23%; "0" ≠ null. Nežinoma: null; žinomas nulis: 0.
totals · Suvestinės; tax_breakdown.groups · Mokesčių grupės; Nepriskirtas mokestis = order.tax − Σ groups.tax; ±.

payment.amount yra užsakymo bendra suma. Mokėjimo būsena nenustato sumokėtų, grąžintų ar nesumokėtų sumų.

Parametrai

Kelio parametrai

order_idEilutėPrivalomas

Susijusio užsakymo identifikatorius.

Apribojimai

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

Pavyzdys: "example"

Ši operacija nepriima JSON turinio.

Atsakymai

Atsakymas 200

Visas modelis: ApiResponse_OrderDetailData_

dataOrderDetailData Privalomas

Sėkmingo atsakymo duomenys.

Laukai · data

Visas modelis: OrderDetailData

created_atEilutėPrivalomas

Sukūrimo laikas.

format: "date-time"

customerCustomerData Privalomas

Šiam ištekliui užregistruota kliento informacija.

Laukai · customer

Visas modelis: CustomerData

emailEilutėPrivalomas: El. pašto adresas.
first_nameEilutė nullPrivalomas: Vardas.
last_nameEilutė nullPrivalomas: Pavardė.
phoneEilutė nullPrivalomas: Telefono numeris.

deliveryShippingDetailData Privalomas

Pristatymo būdas ir susijusi informacija.

Laukai · delivery

Visas modelis: ShippingDetailData

amountMoneyData Privalomas

Dešimtainė suma, užkoduota JSON eilute; null tik ten, kur leidžiama.

datesDeliveryDatesData Privalomas

Išsiuntimo ir pristatymo datos

discount_grossMoneyData Privalomas

Bendroji suma · Nuolaidos; Nežinoma: null; žinomas nulis: 0.

discount_netMoneyData nullPrivalomas

Grynoji suma · Nuolaidos; Nežinoma: null; žinomas nulis: 0.

discount_taxMoneyData nullPrivalomas

Mokesčio suma · Nuolaidos; Nežinoma: null; žinomas nulis: 0.

discountsMasyvas <OrderDeliveryDiscountData > nullPrivalomas

Nuolaidos

grossMoneyData Privalomas

Bendroji suma · Po nuolaidų; Nežinoma: null; žinomas nulis: 0.

method_codeEilutė nullPrivalomas

Pristatymo arba mokėjimo būdo kodas.

method_nameEilutė nullPrivalomas

Pristatymo arba mokėjimo būdo pavadinimas.

netMoneyData nullPrivalomas

Grynoji suma · Po nuolaidų; Nežinoma: null; žinomas nulis: 0.

original_grossMoneyData Privalomas

Bendroji suma · Pristatymas · Prieš nuolaidas; Nežinoma: null; žinomas nulis: 0.

original_netMoneyData nullPrivalomas

Grynoji suma · Pristatymas · Prieš nuolaidas; Nežinoma: null; žinomas nulis: 0.

original_taxMoneyData nullPrivalomas

Mokesčio suma · Pristatymas · Prieš nuolaidas; Nežinoma: null; žinomas nulis: 0.

pickup_pointDeliveryPickupPointData nullPrivalomas

Atsiėmimo vieta

recipient_modeEilutėPrivalomas

Duomenų struktūros atmaina, apibrėžta leidžiamomis reikšmėmis.

Apribojimai

enum: ["full_address", "pickup_contact"]

taxMoneyData nullPrivalomas

Mokesčių informacija.

tax_category_idEilutė nullPrivalomas

Mokesčių kategorijos identifikatorius.

tax_category_nameEilutė nullPrivalomas

Išsaugotas mokesčių kategorijos pavadinimas; null.

tax_rateEilutė nullPrivalomas

tax_rate · Išsaugoti užsakymo duomenys: "0.23" = 23%; "0" ≠ null.

discount_amountMoneyData Privalomas

Dešimtainė suma, užkoduota JSON eilute; null tik ten, kur leidžiama.

Laukai · discount_amount

Visas modelis: MoneyData

amountEilutėPrivalomas

Dešimtainė suma, užkoduota JSON eilute; null tik ten, kur leidžiama.

currencyEilutėPrivalomas

Sumos valiutos kodas.

Apribojimai

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

minor_unitsSveikasis skaičiusPrivalomas

Valiutos naudojamų skaitmenų po kablelio skaičius.

minimum: 0maximum: 4

discountsMasyvas <OrderDiscountData > Privalomas

Nuolaidos

Laukai · discounts

OrderDiscountData

Visas modelis: OrderDiscountData

idEilutėPrivalomas

Ištekliaus identifikatorius; išsaugokite grąžintą išraišką.

invoiceInvoiceData nullPrivalomas

Sąskaitos faktūros informacija.

Laukai · invoice

InvoiceData

Visas modelis: InvoiceData

null

invoice_requestedLoginė reikšmėPrivalomas

Ar prašoma sąskaitos faktūros.

lifecycle_stateOrderLifecycleState Privalomas

Verslo gyvavimo ciklo būsena.

linesMasyvas <OrderLineData > Privalomas

Užsakymo eilučių momentinės kopijos.

Laukai · lines

OrderLineData

Visas modelis: OrderLineData

localeEilutėPrivalomas

Šiai užklausai pasirinkta kalba.

market_idEilutėPrivalomas

Konteksto prieigos taško grąžintas rinkos identifikatorius.

numberEilutėPrivalomas

Žmogui rodomas užsakymo arba prašymo numeris.

paymentPaymentData Privalomas

Užsakymui užregistruoti mokėjimo duomenys.

Laukai · payment

Visas modelis: PaymentData

amountMoneyData Privalomas

Dešimtainė suma, užkoduota JSON eilute; null tik ten, kur leidžiama.

environmentEilutėPrivalomas

Prie įrašo pridėta aplinkos informacija.

Apribojimai

enum: ["live", "sandbox"]

method_codeEilutė nullPrivalomas

Pristatymo arba mokėjimo būdo kodas.

method_nameEilutė nullPrivalomas

Pristatymo arba mokėjimo būdo pavadinimas.

paid_atEilutė nullPrivalomas

Data ir laikas, kai mokėjimas pažymėtas kaip apmokėtas.

Eilutė:format: "date-time"

statusOrderPaymentStatus Privalomas

Šios konkrečios operacijos priimama būsena.

updated_atEilutėPrivalomas

Paskutinio atnaujinimo laikas.

format: "date-time"

versionSveikasis skaičiusPrivalomas

Ištekliaus versija lygiagrečių pakeitimų kontrolei.

pickup_pointPickupPointData nullPrivalomas

Atsiėmimo vieta

Laukai · pickup_point

PickupPointData

Visas modelis: PickupPointData

null

prices_include_taxLoginė reikšmėPrivalomas

Ar nurodytos kainos apima mokesčius.

shipping_addressAddressData nullPrivalomas

Pristatymo adresas.

Laukai · shipping_address

AddressData

Visas modelis: AddressData

null

shipping_discount_amountMoneyData Privalomas

Dešimtainė suma, užkoduota JSON eilute; null tik ten, kur leidžiama.

Laukai · shipping_discount_amount

Visas modelis: MoneyData

amountEilutėPrivalomas

Dešimtainė suma, užkoduota JSON eilute; null tik ten, kur leidžiama.

currencyEilutėPrivalomas

Sumos valiutos kodas.

Apribojimai

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

minor_unitsSveikasis skaičiusPrivalomas

Valiutos naudojamų skaitmenų po kablelio skaičius.

minimum: 0maximum: 4

statusOrderStatusData Privalomas

Šios konkrečios operacijos priimama būsena.

Laukai · status

Visas modelis: OrderStatusData

idEilutėPrivalomas: Ištekliaus identifikatorius; išsaugokite grąžintą išraišką.
nameEilutėPrivalomas: Ištekliaus pavadinimas atitinkamame kontekste.
updated_atEilutėPrivalomas: Paskutinio atnaujinimo laikas.
format: "date-time"
versionSveikasis skaičiusPrivalomas: Ištekliaus versija lygiagrečių pakeitimų kontrolei.

subtotalMoneyData Privalomas

Suma prieš papildomus atsakyme parodytus komponentus.

Laukai · subtotal

Visas modelis: MoneyData

amountEilutėPrivalomas

Dešimtainė suma, užkoduota JSON eilute; null tik ten, kur leidžiama.

currencyEilutėPrivalomas

Sumos valiutos kodas.

Apribojimai

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

minor_unitsSveikasis skaičiusPrivalomas

Valiutos naudojamų skaitmenų po kablelio skaičius.

minimum: 0maximum: 4

taxMoneyData Privalomas

Mokesčių informacija.

Laukai · tax

Visas modelis: MoneyData

amountEilutėPrivalomas

Dešimtainė suma, užkoduota JSON eilute; null tik ten, kur leidžiama.

currencyEilutėPrivalomas

Sumos valiutos kodas.

Apribojimai

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

minor_unitsSveikasis skaičiusPrivalomas

Valiutos naudojamų skaitmenų po kablelio skaičius.

minimum: 0maximum: 4

tax_breakdownOrderTaxBreakdownData Privalomas

Mokesčių grupės · source + tax_rate; unallocated_tax.

Laukai · tax_breakdown

Visas modelis: OrderTaxBreakdownData

groupsMasyvas <OrderTaxGroupData > Privalomas: Mokesčių grupės · source + tax_rate; Nežinoma: null; žinomas nulis: 0.
unallocated_taxMoneyData Privalomas: Nepriskirtas mokestis = order.tax − Σ groups.tax; ±.

tax_country_codeEilutė nullPrivalomas

Apmokestinimo šalis · Išsaugoti užsakymo duomenys · ISO 3166-1 alpha-2; null.

totalMoneyData Privalomas

Bendra suma.

Laukai · total

Visas modelis: MoneyData

amountEilutėPrivalomas

Dešimtainė suma, užkoduota JSON eilute; null tik ten, kur leidžiama.

currencyEilutėPrivalomas

Sumos valiutos kodas.

Apribojimai

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

minor_unitsSveikasis skaičiusPrivalomas

Valiutos naudojamų skaitmenų po kablelio skaičius.

minimum: 0maximum: 4

totalsOrderTotalsData Privalomas

Suvestinės · net / tax / gross; Prieš nuolaidas / Po nuolaidų.

Laukai · totals

Visas modelis: OrderTotalsData

before_discountsOrderAmountBreakdownData Privalomas: Užsakymas · Prieš nuolaidas · net / tax / gross.
discountsOrderAmountBreakdownData Privalomas: Nuolaidos
orderOrderAmountBreakdownData Privalomas: Užsakymas · Po nuolaidų · net / tax / gross.
product_discountsOrderAmountBreakdownData Privalomas: Produktai · Nuolaidos · net / tax / gross.
productsOrderAmountBreakdownData Privalomas: Produktai · Po nuolaidų · net / tax / gross.
products_before_discountsOrderAmountBreakdownData Privalomas: Produktai · Prieš nuolaidas · net / tax / gross.
shippingOrderAmountBreakdownData Privalomas: Pristatymas · Po nuolaidų · net / tax / gross.
shipping_before_discountsOrderAmountBreakdownData Privalomas: Pristatymas · Prieš nuolaidas · net / tax / gross.
shipping_discountsOrderAmountBreakdownData Privalomas: Pristatymas · Nuolaidos · net / tax / gross.

metaContextPageMeta ContextMeta PageMeta RequestMeta Privalomas

Atsakymo metaduomenys.

Laukai · meta

ContextPageMeta

Visas modelis: ContextPageMeta

localeEilutėPrivalomas: Šiai užklausai pasirinkta kalba.
market_codeEilutėPrivalomas: Konteksto prieigos taško grąžintas rinkos kodas.
market_idEilutėPrivalomas: Konteksto prieigos taško grąžintas rinkos identifikatorius.
paginationPagination Privalomas: Skaidymo į puslapius pagal žymeklį metaduomenys.
request_idEilutėPrivalomas: Prašymo identifikatorius; atsakymo metaduomenyse nurodo HTTP užklausą.
minLength: 1maxLength: 100

ContextMeta

Visas modelis: ContextMeta

localeEilutėPrivalomas: Šiai užklausai pasirinkta kalba.
market_codeEilutėPrivalomas: Konteksto prieigos taško grąžintas rinkos kodas.
market_idEilutėPrivalomas: Konteksto prieigos taško grąžintas rinkos identifikatorius.
request_idEilutėPrivalomas: Prašymo identifikatorius; atsakymo metaduomenyse nurodo HTTP užklausą.
minLength: 1maxLength: 100

PageMeta

Visas modelis: PageMeta

paginationPagination Privalomas: Skaidymo į puslapius pagal žymeklį metaduomenys.
request_idEilutėPrivalomas: Prašymo identifikatorius; atsakymo metaduomenyse nurodo HTTP užklausą.
minLength: 1maxLength: 100

RequestMeta

Visas modelis: RequestMeta

request_idEilutėPrivalomas: Prašymo identifikatorius; atsakymo metaduomenyse nurodo HTTP užklausą.
minLength: 1maxLength: 100

Atsakymo pavyzdys

HTTP būsena

200: Sėkmingas atsakymas Schema
400: Netinkama užklausa
401: Būtinas tapatybės patvirtinimas
403: Prieiga uždrausta
404: Išteklius nerastas
409: Versijų konfliktas
422: Tikrinimo klaida
429: Viršytas užklausų limitas

Kitos HTTP būsenos (7)

405: Metodas neleidžiamas
413: Užklausa per didelė
415: Nepalaikomas formatas
500: Serverio klaida
502: API tinklų sietuvo klaida
503: Paslauga nepasiekiama
504: Baigėsi laukimo laikas

Klaidų katalogas: ErrorResponse

Antraštės

401

WWW-AuthenticateEilutėNeprivalomas: Serverio reikalaujama tapatybės patvirtinimo schema.

405

AllowEilutėNeprivalomas: Šio ištekliaus palaikomi HTTP metodai.

429, 503

Retry-AfterSveikasis skaičiusNeprivalomas: Mažiausias laukimo laikas prieš kartojant, sekundėmis.

minimum: 0

Klaidų katalogas · Sužinoti daugiau

GET/api/v1/orders/{order_id}

Kodo pavyzdžiai

Užklausos pavyzdys

cURL

PHP

Python

Atsakymo pavyzdys 200

Kaip tai veikia

Užsakymas · Suvestinės

Parametrai

Kelio parametrai

Atsakymai

Atsakymas 200

HTTP būsena

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