Hae — Tilaukset

Lue tietoja resurssista ”Tilaukset”. Tulos riippuu toiminnon parametreista.

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

Todentaminen: Bearer
Saatavilla alkaen: BASIC
Vaaditut käyttöoikeudet: orders.order:read

Pyyntöesimerkki

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

Vastausesimerkki 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"
  }
}

Periaatteet

Kokoelma sisältää tilausten yhteenvedot ja suodattimet numerolle, tilalle, maksutilalle ja luontiajalle.
Tilausluettelo ja tiedot sisältävät delivery.dates-objektin. YYYY-MM-DD-päivät ovat suunniteltuja eivätkä vahvista lähetystä. Nykyiset päivät ovat ensisijaisia; vanhat tilaukset käyttävät tallennettua arviota. Poistetut tai tuntemattomat arvot ovat null. Tiedot sisältävät myös kaikki tilausrivit ja tuotekuvat.

Hae kelvolliset tilatunnisteet osoitteesta /api/v1/order-statuses.
Tilauksen tila ja maksun tila käyttävät erillisiä PATCH-päätepisteitä ja käyttöoikeuksia.
Kirjatun maksutilan muuttaminen ei veloita korttia eikä käynnistä palautusta maksupalveluntarjoajan kautta.

Turvalliset kirjoitukset

Käyttöoikeudet ja paketit

Tilaus · Yhteissummat

Summat ja verokannat tulevat tallennetusta tilauksesta rivikorjauksineen. Puuttuvat historiatiedot ovat null, eikä niitä korvata luettelon nykyisillä verokannoilla. Summat pysyvät desimaalimerkkijonoina.

Lista palauttaa yhteenvedot. Nouda GET /api/v1/orders/{order_id} kullekin tulokselle täydellisiä taloustietoja varten. GET-uusinnat ovat rajattuja ja noudattavat Retry-After-arvoa. Luontipäivään perustuva vienti ei synkronoi myöhempiä korjauksia.

tax_country_code · Verotusmaa · Tallennetut tilaustiedot · ISO 3166-1 alpha-2; null.
lines[].unit_* · Yksi yksikkö · Ennen alennuksia; lines[].original_total_* · Ennen alennuksia; lines[].total_* · Alennusten jälkeen.
lines[].discount_* · Alennukset; manual_discount · Manuaalinen alennus; percentage "10" = 10%.
delivery.net / tax / gross · Alennusten jälkeen; delivery.original_* · Ennen alennuksia; delivery.discount_* · Alennukset.
tax_rate: "0.23" = 23%; "0" ≠ null. Tuntematon: null; tunnettu nolla: 0.
totals · Yhteissummat; tax_breakdown.groups · Veroryhmät; Kohdistamaton vero = order.tax − Σ groups.tax; ±.

payment.amount on tilauksen kokonaissumma. Maksutila ei määritä maksettuja, palautettuja tai avoimia summia.

Parametrit

Polkuparametrit

order_idMerkkijonoPakollinen

Liittyvän tilauksen tunniste.

Rajoitukset

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

Esimerkki: "example"

Tämä toiminto ei hyväksy JSON-sisältöä.

Vastaukset

Vastaus 200

Koko malli: ApiResponse_OrderDetailData_

dataOrderDetailData Pakollinen

Onnistuneen vastauksen sisältö.

Kentät · data

Koko malli: OrderDetailData

created_atMerkkijonoPakollinen

Luontiajankohta.

format: "date-time"

customerCustomerData Pakollinen

Tälle resurssille kirjatut asiakastiedot.

Kentät · customer

Koko malli: CustomerData

emailMerkkijonoPakollinen: Sähköpostiosoite.
first_nameMerkkijono nullPakollinen: Etunimi.
last_nameMerkkijono nullPakollinen: Sukunimi.
phoneMerkkijono nullPakollinen: Puhelinnumero.

deliveryShippingDetailData Pakollinen

Toimitustapa ja siihen liittyvät tiedot.

Kentät · delivery

Koko malli: ShippingDetailData

amountMoneyData Pakollinen

JSON-merkkijonona esitetty desimaalimäärä; null vain, jos se on sallittu.

datesDeliveryDatesData Pakollinen

Lähetys- ja toimituspäivät

discount_grossMoneyData Pakollinen

Verollinen summa · Alennukset; Tuntematon: null; tunnettu nolla: 0.

discount_netMoneyData nullPakollinen

Veroton summa · Alennukset; Tuntematon: null; tunnettu nolla: 0.

discount_taxMoneyData nullPakollinen

Veron määrä · Alennukset; Tuntematon: null; tunnettu nolla: 0.

discountsTaulukko <OrderDeliveryDiscountData > nullPakollinen

Alennukset

grossMoneyData Pakollinen

Verollinen summa · Alennusten jälkeen; Tuntematon: null; tunnettu nolla: 0.

method_codeMerkkijono nullPakollinen

Toimitus- tai maksutavan koodi.

method_nameMerkkijono nullPakollinen

Toimitus- tai maksutavan nimi.

netMoneyData nullPakollinen

Veroton summa · Alennusten jälkeen; Tuntematon: null; tunnettu nolla: 0.

original_grossMoneyData Pakollinen

Verollinen summa · Toimitus · Ennen alennuksia; Tuntematon: null; tunnettu nolla: 0.

original_netMoneyData nullPakollinen

Veroton summa · Toimitus · Ennen alennuksia; Tuntematon: null; tunnettu nolla: 0.

original_taxMoneyData nullPakollinen

Veron määrä · Toimitus · Ennen alennuksia; Tuntematon: null; tunnettu nolla: 0.

pickup_pointDeliveryPickupPointData nullPakollinen

Noutopiste

recipient_modeMerkkijonoPakollinen

Tietorakenteen muoto, joka kuvataan sallituilla arvoilla.

Rajoitukset

enum: ["full_address", "pickup_contact"]

taxMoneyData nullPakollinen

Verotiedot.

tax_category_idMerkkijono nullPakollinen

Veroluokan tunniste.

tax_category_nameMerkkijono nullPakollinen

Veroluokan tallennettu nimi; null.

tax_rateMerkkijono nullPakollinen

tax_rate · Tallennetut tilaustiedot: "0.23" = 23%; "0" ≠ null.

discount_amountMoneyData Pakollinen

JSON-merkkijonona esitetty desimaalimäärä; null vain, jos se on sallittu.

Kentät · discount_amount

Koko malli: MoneyData

amountMerkkijonoPakollinen

JSON-merkkijonona esitetty desimaalimäärä; null vain, jos se on sallittu.

currencyMerkkijonoPakollinen

Summan valuuttakoodi.

Rajoitukset

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

minor_unitsKokonaislukuPakollinen

Valuutan käyttämien desimaalinumeroiden määrä.

minimum: 0maximum: 4

discountsTaulukko <OrderDiscountData > Pakollinen

Alennukset

Kentät · discounts

OrderDiscountData

Koko malli: OrderDiscountData

idMerkkijonoPakollinen

Resurssin tunniste; säilytä se palautetussa muodossa.

invoiceInvoiceData nullPakollinen

Laskutiedot.

Kentät · invoice

InvoiceData

Koko malli: InvoiceData

null

invoice_requestedTotuusarvoPakollinen

Pyydettiinkö laskua.

lifecycle_stateOrderLifecycleState Pakollinen

Liiketoiminnan elinkaaritila.

linesTaulukko <OrderLineData > Pakollinen

Tilausrivien tilannekuvat.

Kentät · lines

OrderLineData

Koko malli: OrderLineData

localeMerkkijonoPakollinen

Tälle pyynnölle valittu kieli.

market_idMerkkijonoPakollinen

Kontekstipäätepisteen palauttama markkinatunniste.

numberMerkkijonoPakollinen

Ihmiselle tarkoitettu tilaus- tai tapausnumero.

paymentPaymentData Pakollinen

Tilaukselle kirjatut maksutiedot.

Kentät · payment

Koko malli: PaymentData

amountMoneyData Pakollinen

JSON-merkkijonona esitetty desimaalimäärä; null vain, jos se on sallittu.

environmentMerkkijonoPakollinen

Tietueeseen liitetyt ympäristötiedot.

Rajoitukset

enum: ["live", "sandbox"]

method_codeMerkkijono nullPakollinen

Toimitus- tai maksutavan koodi.

method_nameMerkkijono nullPakollinen

Toimitus- tai maksutavan nimi.

paid_atMerkkijono nullPakollinen

Päivämäärä ja aika, jolloin maksu merkittiin maksetuksi.

Merkkijono:format: "date-time"

statusOrderPaymentStatus Pakollinen

Tämän nimenomaisen toiminnon hyväksymä tila.

updated_atMerkkijonoPakollinen

Viimeisimmän päivityksen ajankohta.

format: "date-time"

versionKokonaislukuPakollinen

Samanaikaisuuden hallintaan käytetty resurssiversio.

pickup_pointPickupPointData nullPakollinen

Noutopiste

Kentät · pickup_point

PickupPointData

Koko malli: PickupPointData

null

prices_include_taxTotuusarvoPakollinen

Sisältävätkö luetellut hinnat verot.

shipping_addressAddressData nullPakollinen

Toimitusosoite.

Kentät · shipping_address

AddressData

Koko malli: AddressData

null

shipping_discount_amountMoneyData Pakollinen

JSON-merkkijonona esitetty desimaalimäärä; null vain, jos se on sallittu.

Kentät · shipping_discount_amount

Koko malli: MoneyData

amountMerkkijonoPakollinen

JSON-merkkijonona esitetty desimaalimäärä; null vain, jos se on sallittu.

currencyMerkkijonoPakollinen

Summan valuuttakoodi.

Rajoitukset

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

minor_unitsKokonaislukuPakollinen

Valuutan käyttämien desimaalinumeroiden määrä.

minimum: 0maximum: 4

statusOrderStatusData Pakollinen

Tämän nimenomaisen toiminnon hyväksymä tila.

Kentät · status

Koko malli: OrderStatusData

idMerkkijonoPakollinen: Resurssin tunniste; säilytä se palautetussa muodossa.
nameMerkkijonoPakollinen: Resurssin nimi kyseisessä kontekstissa.
updated_atMerkkijonoPakollinen: Viimeisimmän päivityksen ajankohta.
format: "date-time"
versionKokonaislukuPakollinen: Samanaikaisuuden hallintaan käytetty resurssiversio.

subtotalMoneyData Pakollinen

Summa ennen vastauksessa esitettyjä lisäosia.

Kentät · subtotal

Koko malli: MoneyData

amountMerkkijonoPakollinen

JSON-merkkijonona esitetty desimaalimäärä; null vain, jos se on sallittu.

currencyMerkkijonoPakollinen

Summan valuuttakoodi.

Rajoitukset

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

minor_unitsKokonaislukuPakollinen

Valuutan käyttämien desimaalinumeroiden määrä.

minimum: 0maximum: 4

taxMoneyData Pakollinen

Verotiedot.

Kentät · tax

Koko malli: MoneyData

amountMerkkijonoPakollinen

JSON-merkkijonona esitetty desimaalimäärä; null vain, jos se on sallittu.

currencyMerkkijonoPakollinen

Summan valuuttakoodi.

Rajoitukset

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

minor_unitsKokonaislukuPakollinen

Valuutan käyttämien desimaalinumeroiden määrä.

minimum: 0maximum: 4

tax_breakdownOrderTaxBreakdownData Pakollinen

Veroryhmät · source + tax_rate; unallocated_tax.

Kentät · tax_breakdown

Koko malli: OrderTaxBreakdownData

groupsTaulukko <OrderTaxGroupData > Pakollinen: Veroryhmät · source + tax_rate; Tuntematon: null; tunnettu nolla: 0.
unallocated_taxMoneyData Pakollinen: Kohdistamaton vero = order.tax − Σ groups.tax; ±.

tax_country_codeMerkkijono nullPakollinen

Verotusmaa · Tallennetut tilaustiedot · ISO 3166-1 alpha-2; null.

totalMoneyData Pakollinen

Kokonaissumma.

Kentät · total

Koko malli: MoneyData

amountMerkkijonoPakollinen

JSON-merkkijonona esitetty desimaalimäärä; null vain, jos se on sallittu.

currencyMerkkijonoPakollinen

Summan valuuttakoodi.

Rajoitukset

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

minor_unitsKokonaislukuPakollinen

Valuutan käyttämien desimaalinumeroiden määrä.

minimum: 0maximum: 4

totalsOrderTotalsData Pakollinen

Yhteissummat · net / tax / gross; Ennen alennuksia / Alennusten jälkeen.

Kentät · totals

Koko malli: OrderTotalsData

before_discountsOrderAmountBreakdownData Pakollinen: Tilaus · Ennen alennuksia · net / tax / gross.
discountsOrderAmountBreakdownData Pakollinen: Alennukset
orderOrderAmountBreakdownData Pakollinen: Tilaus · Alennusten jälkeen · net / tax / gross.
product_discountsOrderAmountBreakdownData Pakollinen: Tuotteet · Alennukset · net / tax / gross.
productsOrderAmountBreakdownData Pakollinen: Tuotteet · Alennusten jälkeen · net / tax / gross.
products_before_discountsOrderAmountBreakdownData Pakollinen: Tuotteet · Ennen alennuksia · net / tax / gross.
shippingOrderAmountBreakdownData Pakollinen: Toimitus · Alennusten jälkeen · net / tax / gross.
shipping_before_discountsOrderAmountBreakdownData Pakollinen: Toimitus · Ennen alennuksia · net / tax / gross.
shipping_discountsOrderAmountBreakdownData Pakollinen: Toimitus · Alennukset · net / tax / gross.

metaContextPageMeta ContextMeta PageMeta RequestMeta Pakollinen

Vastauksen metatiedot.

Kentät · meta

ContextPageMeta

Koko malli: ContextPageMeta

localeMerkkijonoPakollinen: Tälle pyynnölle valittu kieli.
market_codeMerkkijonoPakollinen: Kontekstipäätepisteen palauttama markkinakoodi.
market_idMerkkijonoPakollinen: Kontekstipäätepisteen palauttama markkinatunniste.
paginationPagination Pakollinen: Kohdistinpohjaisen sivutuksen metatiedot.
request_idMerkkijonoPakollinen: Tapauksen tunniste; vastauksen metatiedoissa se yksilöi HTTP-pyynnön.
minLength: 1maxLength: 100

ContextMeta

Koko malli: ContextMeta

localeMerkkijonoPakollinen: Tälle pyynnölle valittu kieli.
market_codeMerkkijonoPakollinen: Kontekstipäätepisteen palauttama markkinakoodi.
market_idMerkkijonoPakollinen: Kontekstipäätepisteen palauttama markkinatunniste.
request_idMerkkijonoPakollinen: Tapauksen tunniste; vastauksen metatiedoissa se yksilöi HTTP-pyynnön.
minLength: 1maxLength: 100

PageMeta

Koko malli: PageMeta

paginationPagination Pakollinen: Kohdistinpohjaisen sivutuksen metatiedot.
request_idMerkkijonoPakollinen: Tapauksen tunniste; vastauksen metatiedoissa se yksilöi HTTP-pyynnön.
minLength: 1maxLength: 100

RequestMeta

Koko malli: RequestMeta

request_idMerkkijonoPakollinen: Tapauksen tunniste; vastauksen metatiedoissa se yksilöi HTTP-pyynnön.
minLength: 1maxLength: 100

Vastausesimerkki

HTTP-tilakoodi

200: Onnistunut vastaus Skeema
400: Virheellinen pyyntö
401: Tunnistautuminen vaaditaan
403: Pääsy estetty
404: Resurssia ei löydy
409: Versioristiriita
422: Validointi epäonnistui
429: Pyyntöraja ylitetty

Muut HTTP-tilat (7)

405: Menetelmä ei ole sallittu
413: Pyyntö on liian suuri
415: Muotoa ei tueta
500: Palvelinvirhe
502: API-yhdyskäytävän virhe
503: Palvelu ei ole käytettävissä
504: Aikakatkaisu

Virheluettelo: ErrorResponse

Otsakkeet

401

WWW-AuthenticateMerkkijonoValinnainen: Palvelimen vaatima todentamismenetelmä.

405

AllowMerkkijonoValinnainen: Tämän resurssin tukemat HTTP-metodit.

429, 503

Retry-AfterKokonaislukuValinnainen: Vähimmäisviive ennen uudelleenyritystä sekunteina.

minimum: 0

Virheluettelo · Lue lisää

GET/api/v1/orders/{order_id}

Koodiesimerkit

Pyyntöesimerkki

cURL

PHP

Python

Vastausesimerkki 200

Periaatteet

Tilaus · Yhteissummat

Parametrit

Polkuparametrit

Vastaukset

Vastaus 200

HTTP-tilakoodi

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