Hangi — Tellimused

Lugege andmeid ressursist „Tellimused“. Tulemus sõltub toimingu parameetritest.

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

Autentimine: Bearer
Saadaval alates: BASIC
Nõutavad õigused: orders.order:read

Päringu näide

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

Vastuse näide 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"
  }
}

Kuidas see toimib

Kogum annab tellimuste kokkuvõtted ning numbri, oleku, makseoleku ja loomise aja filtrid.
Tellimuste loend ja üksikasjad sisaldavad delivery.dates. Kuupäevad YYYY-MM-DD on kavandatud ega kinnita saatmist. Praegused kuupäevad on ülimuslikud; vanemad tellimused kasutavad salvestatud hinnangut. Kustutatud või teadmata väärtused on null. Üksikasjad sisaldavad ka kõiki tellimusridu ja tootepilte.

Loe kehtivad olekuidentifikaatorid /api/v1/order-statuses kaudu.
Tellimuse ja makse olekul on eraldi PATCH-lõpp-punktid ja õigused.
Salvestatud makseoleku muutmine ei võta kaardilt raha ega tee makseteenuse kaudu tagasimakset.

Turvalised muudatused

Õigused ja paketid

Tellimus · Kogusummad

Summad ja maksumäärad pärinevad salvestatud tellimusest koos reaparandustega. Puuduvad ajaloolised andmed on null ja neid ei asendata kataloogi praeguste määradega. Summad jäävad kümnendstringideks.

Loend tagastab kokkuvõtted. Täielike finantsandmete eksportimiseks pärige iga tulemuse kohta GET /api/v1/orders/{order_id}. GET-kordused on piiratud ja järgivad Retry-After väärtust. Loomiskuupäeva järgi eksport ei sünkrooni hilisemaid parandusi.

tax_country_code · Maksuriik · Salvestatud tellimusandmed · ISO 3166-1 alpha-2; null.
lines[].unit_* · Üks ühik · Enne allahindlusi; lines[].original_total_* · Enne allahindlusi; lines[].total_* · Pärast allahindlusi.
lines[].discount_* · Allahindlused; manual_discount · Käsitsi allahindlus; percentage "10" = 10%.
delivery.net / tax / gross · Pärast allahindlusi; delivery.original_* · Enne allahindlusi; delivery.discount_* · Allahindlused.
tax_rate: "0.23" = 23%; "0" ≠ null. Teadmata: null; teadaolev nullväärtus: 0.
totals · Kogusummad; tax_breakdown.groups · Maksurühmad; Jaotamata maks = order.tax − Σ groups.tax; ±.

payment.amount on tellimuse kogusumma. Makse olek ei määra tasutud, tagastatud ega tasumata summasid.

Parameetrid

Tee parameetrid

order_idStringKohustuslik

Seotud tellimuse identifikaator.

Piirangud

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

Näide: "example"

See toiming ei võta vastu JSON-sisu.

Vastused

Vastus 200

Täielik mudel: ApiResponse_OrderDetailData_

dataOrderDetailData Kohustuslik

Eduka vastuse andmed.

Väljad · data

Täielik mudel: OrderDetailData

created_atStringKohustuslik

Loomise aeg.

format: "date-time"

customerCustomerData Kohustuslik

Selle ressursi juurde salvestatud klienditeave.

Väljad · customer

Täielik mudel: CustomerData

emailStringKohustuslik: E-posti aadress.
first_nameString nullKohustuslik: Eesnimi.
last_nameString nullKohustuslik: Perekonnanimi.
phoneString nullKohustuslik: Telefoninumber.

deliveryShippingDetailData Kohustuslik

Tarneviis ja seotud teave.

Väljad · delivery

Täielik mudel: ShippingDetailData

amountMoneyData Kohustuslik

JSON-stringina kodeeritud kümnendsumma; null ainult lubatud juhtudel.

datesDeliveryDatesData Kohustuslik

Saatmis- ja tarnekuupäevad

discount_grossMoneyData Kohustuslik

Brutosumma · Allahindlused; Teadmata: null; teadaolev nullväärtus: 0.

discount_netMoneyData nullKohustuslik

Netosumma · Allahindlused; Teadmata: null; teadaolev nullväärtus: 0.

discount_taxMoneyData nullKohustuslik

Maksusumma · Allahindlused; Teadmata: null; teadaolev nullväärtus: 0.

discountsMassiiv <OrderDeliveryDiscountData > nullKohustuslik

Allahindlused

grossMoneyData Kohustuslik

Brutosumma · Pärast allahindlusi; Teadmata: null; teadaolev nullväärtus: 0.

method_codeString nullKohustuslik

Tarne- või makseviisi kood.

method_nameString nullKohustuslik

Tarne- või makseviisi nimi.

netMoneyData nullKohustuslik

Netosumma · Pärast allahindlusi; Teadmata: null; teadaolev nullväärtus: 0.

original_grossMoneyData Kohustuslik

Brutosumma · Tarne · Enne allahindlusi; Teadmata: null; teadaolev nullväärtus: 0.

original_netMoneyData nullKohustuslik

Netosumma · Tarne · Enne allahindlusi; Teadmata: null; teadaolev nullväärtus: 0.

original_taxMoneyData nullKohustuslik

Maksusumma · Tarne · Enne allahindlusi; Teadmata: null; teadaolev nullväärtus: 0.

pickup_pointDeliveryPickupPointData nullKohustuslik

Väljastuspunkt

recipient_modeStringKohustuslik

Andmestruktuuri variant, mida kirjeldavad lubatud väärtused.

Piirangud

enum: ["full_address", "pickup_contact"]

taxMoneyData nullKohustuslik

Maksuteave.

tax_category_idString nullKohustuslik

Maksukategooria identifikaator.

tax_category_nameString nullKohustuslik

Maksukategooria salvestatud nimi; null.

tax_rateString nullKohustuslik

tax_rate · Salvestatud tellimusandmed: "0.23" = 23%; "0" ≠ null.

discount_amountMoneyData Kohustuslik

JSON-stringina kodeeritud kümnendsumma; null ainult lubatud juhtudel.

Väljad · discount_amount

Täielik mudel: MoneyData

amountStringKohustuslik

JSON-stringina kodeeritud kümnendsumma; null ainult lubatud juhtudel.

currencyStringKohustuslik

Summa valuutakood.

Piirangud

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

minor_unitsTäisarvKohustuslik

Valuuta kasutatavate kümnendkohtade arv.

minimum: 0maximum: 4

discountsMassiiv <OrderDiscountData > Kohustuslik

Allahindlused

Väljad · discounts

OrderDiscountData

Täielik mudel: OrderDiscountData

idStringKohustuslik

Ressursi identifikaator; säilita see tagastatud kujul.

invoiceInvoiceData nullKohustuslik

Arveteave.

Väljad · invoice

InvoiceData

Täielik mudel: InvoiceData

null

invoice_requestedTõeväärtusKohustuslik

Kas arvet sooviti.

lifecycle_stateOrderLifecycleState Kohustuslik

Ärilise elutsükli olek.

linesMassiiv <OrderLineData > Kohustuslik

Tellimusridade hetktõmmised.

Väljad · lines

OrderLineData

Täielik mudel: OrderLineData

localeStringKohustuslik

Selle päringu jaoks valitud keel.

market_idStringKohustuslik

Konteksti lõpp-punkti tagastatud turuidentifikaator.

numberStringKohustuslik

Kasutajale mõeldud tellimuse või pöördumise number.

paymentPaymentData Kohustuslik

Tellimuse juurde salvestatud makseandmed.

Väljad · payment

Täielik mudel: PaymentData

amountMoneyData Kohustuslik

JSON-stringina kodeeritud kümnendsumma; null ainult lubatud juhtudel.

environmentStringKohustuslik

Kirjele lisatud keskkonnateave.

Piirangud

enum: ["live", "sandbox"]

method_codeString nullKohustuslik

Tarne- või makseviisi kood.

method_nameString nullKohustuslik

Tarne- või makseviisi nimi.

paid_atString nullKohustuslik

Kuupäev ja kellaaeg, mil makse märgiti tasutuks.

String:format: "date-time"

statusOrderPaymentStatus Kohustuslik

Selle konkreetse toimingu lubatud olek.

updated_atStringKohustuslik

Viimase uuendamise aeg.

format: "date-time"

versionTäisarvKohustuslik

Ressursi versioon samaaegsuse kontrolliks.

pickup_pointPickupPointData nullKohustuslik

Väljastuspunkt

Väljad · pickup_point

PickupPointData

Täielik mudel: PickupPointData

null

prices_include_taxTõeväärtusKohustuslik

Kas loetletud hinnad sisaldavad maksu.

shipping_addressAddressData nullKohustuslik

Tarneaadress.

Väljad · shipping_address

AddressData

Täielik mudel: AddressData

null

shipping_discount_amountMoneyData Kohustuslik

JSON-stringina kodeeritud kümnendsumma; null ainult lubatud juhtudel.

Väljad · shipping_discount_amount

Täielik mudel: MoneyData

amountStringKohustuslik

JSON-stringina kodeeritud kümnendsumma; null ainult lubatud juhtudel.

currencyStringKohustuslik

Summa valuutakood.

Piirangud

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

minor_unitsTäisarvKohustuslik

Valuuta kasutatavate kümnendkohtade arv.

minimum: 0maximum: 4

statusOrderStatusData Kohustuslik

Selle konkreetse toimingu lubatud olek.

Väljad · status

Täielik mudel: OrderStatusData

idStringKohustuslik: Ressursi identifikaator; säilita see tagastatud kujul.
nameStringKohustuslik: Ressursi nimi vastavas kontekstis.
updated_atStringKohustuslik: Viimase uuendamise aeg.
format: "date-time"
versionTäisarvKohustuslik: Ressursi versioon samaaegsuse kontrolliks.

subtotalMoneyData Kohustuslik

Summa enne vastuses näidatud lisakomponente.

Väljad · subtotal

Täielik mudel: MoneyData

amountStringKohustuslik

JSON-stringina kodeeritud kümnendsumma; null ainult lubatud juhtudel.

currencyStringKohustuslik

Summa valuutakood.

Piirangud

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

minor_unitsTäisarvKohustuslik

Valuuta kasutatavate kümnendkohtade arv.

minimum: 0maximum: 4

taxMoneyData Kohustuslik

Maksuteave.

Väljad · tax

Täielik mudel: MoneyData

amountStringKohustuslik

JSON-stringina kodeeritud kümnendsumma; null ainult lubatud juhtudel.

currencyStringKohustuslik

Summa valuutakood.

Piirangud

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

minor_unitsTäisarvKohustuslik

Valuuta kasutatavate kümnendkohtade arv.

minimum: 0maximum: 4

tax_breakdownOrderTaxBreakdownData Kohustuslik

Maksurühmad · source + tax_rate; unallocated_tax.

Väljad · tax_breakdown

Täielik mudel: OrderTaxBreakdownData

groupsMassiiv <OrderTaxGroupData > Kohustuslik: Maksurühmad · source + tax_rate; Teadmata: null; teadaolev nullväärtus: 0.
unallocated_taxMoneyData Kohustuslik: Jaotamata maks = order.tax − Σ groups.tax; ±.

tax_country_codeString nullKohustuslik

Maksuriik · Salvestatud tellimusandmed · ISO 3166-1 alpha-2; null.

totalMoneyData Kohustuslik

Kogusumma.

Väljad · total

Täielik mudel: MoneyData

amountStringKohustuslik

JSON-stringina kodeeritud kümnendsumma; null ainult lubatud juhtudel.

currencyStringKohustuslik

Summa valuutakood.

Piirangud

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

minor_unitsTäisarvKohustuslik

Valuuta kasutatavate kümnendkohtade arv.

minimum: 0maximum: 4

totalsOrderTotalsData Kohustuslik

Kogusummad · net / tax / gross; Enne allahindlusi / Pärast allahindlusi.

Väljad · totals

Täielik mudel: OrderTotalsData

before_discountsOrderAmountBreakdownData Kohustuslik: Tellimus · Enne allahindlusi · net / tax / gross.
discountsOrderAmountBreakdownData Kohustuslik: Allahindlused
orderOrderAmountBreakdownData Kohustuslik: Tellimus · Pärast allahindlusi · net / tax / gross.
product_discountsOrderAmountBreakdownData Kohustuslik: Tooted · Allahindlused · net / tax / gross.
productsOrderAmountBreakdownData Kohustuslik: Tooted · Pärast allahindlusi · net / tax / gross.
products_before_discountsOrderAmountBreakdownData Kohustuslik: Tooted · Enne allahindlusi · net / tax / gross.
shippingOrderAmountBreakdownData Kohustuslik: Tarne · Pärast allahindlusi · net / tax / gross.
shipping_before_discountsOrderAmountBreakdownData Kohustuslik: Tarne · Enne allahindlusi · net / tax / gross.
shipping_discountsOrderAmountBreakdownData Kohustuslik: Tarne · Allahindlused · net / tax / gross.

metaContextPageMeta ContextMeta PageMeta RequestMeta Kohustuslik

Vastuse metaandmed.

Väljad · meta

ContextPageMeta

Täielik mudel: ContextPageMeta

localeStringKohustuslik: Selle päringu jaoks valitud keel.
market_codeStringKohustuslik: Konteksti lõpp-punkti tagastatud turukood.
market_idStringKohustuslik: Konteksti lõpp-punkti tagastatud turuidentifikaator.
paginationPagination Kohustuslik: Kursoripõhise lehekülgjaotuse metaandmed.
request_idStringKohustuslik: Pöördumise identifikaator; vastuse metaandmetes tähistab see HTTP-päringut.
minLength: 1maxLength: 100

ContextMeta

Täielik mudel: ContextMeta

localeStringKohustuslik: Selle päringu jaoks valitud keel.
market_codeStringKohustuslik: Konteksti lõpp-punkti tagastatud turukood.
market_idStringKohustuslik: Konteksti lõpp-punkti tagastatud turuidentifikaator.
request_idStringKohustuslik: Pöördumise identifikaator; vastuse metaandmetes tähistab see HTTP-päringut.
minLength: 1maxLength: 100

PageMeta

Täielik mudel: PageMeta

paginationPagination Kohustuslik: Kursoripõhise lehekülgjaotuse metaandmed.
request_idStringKohustuslik: Pöördumise identifikaator; vastuse metaandmetes tähistab see HTTP-päringut.
minLength: 1maxLength: 100

RequestMeta

Täielik mudel: RequestMeta

request_idStringKohustuslik: Pöördumise identifikaator; vastuse metaandmetes tähistab see HTTP-päringut.
minLength: 1maxLength: 100

Vastuse näide

HTTP-olek

200: Edukas vastus Skeem
400: Vigane päring
401: Autentimine on nõutav
403: Juurdepääs keelatud
404: Ressurssi ei leitud
409: Versioonikonflikt
422: Valideerimine nurjus
429: Päringupiirang ületatud

Muud HTTP olekud (7)

405: Meetod pole lubatud
413: Päring on liiga suur
415: Vormingut ei toetata
500: Serveri viga
502: API lüüsi viga
503: Teenus pole saadaval
504: Ajalimiit ületatud

Veakataloog: ErrorResponse

Päised

401

WWW-AuthenticateStringValikuline: Serveri nõutav autentimisskeem.

405

AllowStringValikuline: Selle ressursi toetatud HTTP-meetodid.

429, 503

Retry-AfterTäisarvValikuline: Minimaalne viivitus enne korduskatset, sekundites.

minimum: 0

Veakataloog · Lisateave

GET/api/v1/orders/{order_id}

Koodinäited

Päringu näide

cURL

PHP

Python

Vastuse näide 200

Kuidas see toimib

Tellimus · Kogusummad

Parameetrid

Tee parameetrid

Vastused

Vastus 200

HTTP-olek

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