Ga naar de inhoud
ShopentlyLearn
Nederlands

Ophalen — Bestellingen

Lees gegevens uit ‘Bestellingen’. Het resultaat hangt af van de parameters van deze bewerking.

GET/api/v1/orders/{order_id}

Authenticatie
Bearer
Beschikbaar vanaf
BASIC
Vereiste rechten
orders.order:read

Codevoorbeelden

Voorbeeldverzoek

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

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

Werking

  • De verzameling biedt besteloverzichten en filters voor nummer, status, betaalstatus en aanmaaktijd.
  • De bestellijst en details bevatten delivery.dates. Datums in YYYY-MM-DD zijn gepland en bevestigen geen verzending. Actuele datums gaan voor; oudere bestellingen gebruiken de opgeslagen schatting. Gewiste of onbekende waarden zijn null. Details bevatten ook alle bestelregels en productafbeeldingen.
  • Haal geldige statusidentificaties op via /api/v1/order-statuses.
  • Bestelstatus en betaalstatus hebben afzonderlijke PATCH-endpoints en rechten.
  • Een wijziging van de geregistreerde betaalstatus schrijft geen bedrag van een kaart af en voert geen terugbetaling via een betaalprovider uit.

Veilig schrijven

Rechten en abonnementen

Bestelling · Totalen

Bedragen en belastingtarieven komen uit de opgeslagen bestelling, inclusief regelcorrecties. Ontbrekende historische gegevens zijn null en worden niet vervangen door actuele catalogustarieven. Bedragen blijven decimale tekenreeksen.

De lijst geeft samenvattingen. Haal voor elk resultaat GET /api/v1/orders/{order_id} op voor volledige financiële details. GET-pogingen zijn begrensd en respecteren Retry-After. Export op aanmaakdatum synchroniseert latere correcties niet.

  • tax_country_code · Belastingland · Opgeslagen bestelgegevens · ISO 3166-1 alpha-2; null.
  • lines[].unit_* · Eén eenheid · Vóór kortingen; lines[].original_total_* · Vóór kortingen; lines[].total_* · Na kortingen.
  • lines[].discount_* · Kortingen; manual_discount · Handmatige korting; percentage "10" = 10%.
  • delivery.net / tax / gross · Na kortingen; delivery.original_* · Vóór kortingen; delivery.discount_* · Kortingen.
  • tax_rate: "0.23" = 23%; "0" ≠ null. Onbekend: null; bekende nul: 0.
  • totals · Totalen; tax_breakdown.groups · Belastinggroepen; Niet toegewezen belasting = order.tax − Σ groups.tax; ±.

payment.amount is het besteltotaal. De betaalstatus bepaalt geen betaalde, terugbetaalde of openstaande bedragen.

Parameters

Padparameters

order_idTekenreeksVerplicht

Identificatie van de bijbehorende bestelling.

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

Deze bewerking accepteert geen JSON-inhoud.

Antwoorden

Antwoord 200

Volledig model: ApiResponse_OrderDetailData_

dataOrderDetailData Verplicht

Gegevens van een geslaagd antwoord.

Velden · data

Volledig model: OrderDetailData

created_atTekenreeksVerplicht

Tijdstip van aanmaak.

format: "date-time"
customerCustomerData Verplicht

Klantgegevens die voor deze resource zijn vastgelegd.

Velden · customer

Volledig model: CustomerData

emailTekenreeksVerplicht

E-mailadres.

first_nameTekenreeks nullVerplicht

Voornaam.

last_nameTekenreeks nullVerplicht

Achternaam.

phoneTekenreeks nullVerplicht

Telefoonnummer.

deliveryShippingDetailData Verplicht

Verzendmethode en bijbehorende informatie.

Velden · delivery

Volledig model: ShippingDetailData

amountMoneyData Verplicht

Decimaal bedrag als JSON-tekenreeks; null uitsluitend waar toegestaan.

datesDeliveryDatesData Verplicht

Verzend- en bezorgdatums

discount_grossMoneyData Verplicht

Brutobedrag · Kortingen; Onbekend: null; bekende nul: 0.

discount_netMoneyData nullVerplicht

Nettobedrag · Kortingen; Onbekend: null; bekende nul: 0.

discount_taxMoneyData nullVerplicht

Belastingbedrag · Kortingen; Onbekend: null; bekende nul: 0.

discountsArray <OrderDeliveryDiscountData > nullVerplicht

Kortingen

grossMoneyData Verplicht

Brutobedrag · Na kortingen; Onbekend: null; bekende nul: 0.

method_codeTekenreeks nullVerplicht

Code van de verzend- of betaalmethode.

method_nameTekenreeks nullVerplicht

Naam van de verzend- of betaalmethode.

netMoneyData nullVerplicht

Nettobedrag · Na kortingen; Onbekend: null; bekende nul: 0.

original_grossMoneyData Verplicht

Brutobedrag · Verzending · Vóór kortingen; Onbekend: null; bekende nul: 0.

original_netMoneyData nullVerplicht

Nettobedrag · Verzending · Vóór kortingen; Onbekend: null; bekende nul: 0.

original_taxMoneyData nullVerplicht

Belastingbedrag · Verzending · Vóór kortingen; Onbekend: null; bekende nul: 0.

pickup_pointDeliveryPickupPointData nullVerplicht

Afhaalpunt

recipient_modeTekenreeksVerplicht

Variant van de gegevensstructuur, zoals beschreven door de toegestane waarden.

Beperkingen
enum
["full_address", "pickup_contact"]
taxMoneyData nullVerplicht

Belastinggegevens.

tax_category_idTekenreeks nullVerplicht

Identificatie van de belastingcategorie.

tax_category_nameTekenreeks nullVerplicht

Opgeslagen naam van de belastingcategorie; null.

tax_rateTekenreeks nullVerplicht

tax_rate · Opgeslagen bestelgegevens: "0.23" = 23%; "0" ≠ null.

discount_amountMoneyData Verplicht

Decimaal bedrag als JSON-tekenreeks; null uitsluitend waar toegestaan.

Velden · discount_amount

Volledig model: MoneyData

amountTekenreeksVerplicht

Decimaal bedrag als JSON-tekenreeks; null uitsluitend waar toegestaan.

currencyTekenreeksVerplicht

Valutacode voor het bedrag.

Beperkingen
pattern
"^[A-Z]{3}$"
minor_unitsGeheel getalVerplicht

Aantal decimalen van de valuta.

minimum: 0maximum: 4
discountsArray <OrderDiscountData > Verplicht

Kortingen

Velden · discounts

OrderDiscountData

Volledig model: OrderDiscountData

idTekenreeksVerplicht

Resource-identificatie; bewaar deze zoals teruggegeven.

invoiceInvoiceData nullVerplicht

Factuurgegevens.

Velden · invoice

InvoiceData

Volledig model: InvoiceData

null

invoice_requestedBooleaanse waardeVerplicht

Of een factuur is aangevraagd.

lifecycle_stateOrderLifecycleState Verplicht

Status in de zakelijke levenscyclus.

linesArray <OrderLineData > Verplicht

Vastgelegde bestelregels.

Velden · lines

OrderLineData

Volledig model: OrderLineData

localeTekenreeksVerplicht

Taal die voor dit verzoek is geselecteerd.

market_idTekenreeksVerplicht

Marktidentificatie die het contextendpoint teruggeeft.

numberTekenreeksVerplicht

Bestel- of aanvraagnummer voor menselijk gebruik.

paymentPaymentData Verplicht

Betaalgegevens die bij de bestelling zijn vastgelegd.

Velden · payment

Volledig model: PaymentData

amountMoneyData Verplicht

Decimaal bedrag als JSON-tekenreeks; null uitsluitend waar toegestaan.

environmentTekenreeksVerplicht

Omgevingsinformatie die bij de registratie hoort.

Beperkingen
enum
["live", "sandbox"]
method_codeTekenreeks nullVerplicht

Code van de verzend- of betaalmethode.

method_nameTekenreeks nullVerplicht

Naam van de verzend- of betaalmethode.

paid_atTekenreeks nullVerplicht

Datum en tijd waarop de betaling als betaald is gemarkeerd.

Tekenreeks:format: "date-time"
statusOrderPaymentStatus Verplicht

Status die deze specifieke bewerking accepteert.

updated_atTekenreeksVerplicht

Tijdstip van de meest recente wijziging.

format: "date-time"
versionGeheel getalVerplicht

Resourceversie voor controle op gelijktijdige wijzigingen.

pickup_pointPickupPointData nullVerplicht

Afhaalpunt

Velden · pickup_point

PickupPointData

Volledig model: PickupPointData

null

prices_include_taxBooleaanse waardeVerplicht

Of de vermelde prijzen inclusief belasting zijn.

shipping_addressAddressData nullVerplicht

Verzendadres.

Velden · shipping_address

AddressData

Volledig model: AddressData

null

shipping_discount_amountMoneyData Verplicht

Decimaal bedrag als JSON-tekenreeks; null uitsluitend waar toegestaan.

Velden · shipping_discount_amount

Volledig model: MoneyData

amountTekenreeksVerplicht

Decimaal bedrag als JSON-tekenreeks; null uitsluitend waar toegestaan.

currencyTekenreeksVerplicht

Valutacode voor het bedrag.

Beperkingen
pattern
"^[A-Z]{3}$"
minor_unitsGeheel getalVerplicht

Aantal decimalen van de valuta.

minimum: 0maximum: 4
statusOrderStatusData Verplicht

Status die deze specifieke bewerking accepteert.

Velden · status

Volledig model: OrderStatusData

idTekenreeksVerplicht

Resource-identificatie; bewaar deze zoals teruggegeven.

nameTekenreeksVerplicht

Resourcenaam in de betreffende context.

updated_atTekenreeksVerplicht

Tijdstip van de meest recente wijziging.

format: "date-time"
versionGeheel getalVerplicht

Resourceversie voor controle op gelijktijdige wijzigingen.

subtotalMoneyData Verplicht

Bedrag vóór de aanvullende componenten in het antwoord.

Velden · subtotal

Volledig model: MoneyData

amountTekenreeksVerplicht

Decimaal bedrag als JSON-tekenreeks; null uitsluitend waar toegestaan.

currencyTekenreeksVerplicht

Valutacode voor het bedrag.

Beperkingen
pattern
"^[A-Z]{3}$"
minor_unitsGeheel getalVerplicht

Aantal decimalen van de valuta.

minimum: 0maximum: 4
taxMoneyData Verplicht

Belastinggegevens.

Velden · tax

Volledig model: MoneyData

amountTekenreeksVerplicht

Decimaal bedrag als JSON-tekenreeks; null uitsluitend waar toegestaan.

currencyTekenreeksVerplicht

Valutacode voor het bedrag.

Beperkingen
pattern
"^[A-Z]{3}$"
minor_unitsGeheel getalVerplicht

Aantal decimalen van de valuta.

minimum: 0maximum: 4
tax_breakdownOrderTaxBreakdownData Verplicht

Belastinggroepen · source + tax_rate; unallocated_tax.

Velden · tax_breakdown

Volledig model: OrderTaxBreakdownData

groupsArray <OrderTaxGroupData > Verplicht

Belastinggroepen · source + tax_rate; Onbekend: null; bekende nul: 0.

unallocated_taxMoneyData Verplicht

Niet toegewezen belasting = order.tax − Σ groups.tax; ±.

tax_country_codeTekenreeks nullVerplicht

Belastingland · Opgeslagen bestelgegevens · ISO 3166-1 alpha-2; null.

totalMoneyData Verplicht

Totaalbedrag.

Velden · total

Volledig model: MoneyData

amountTekenreeksVerplicht

Decimaal bedrag als JSON-tekenreeks; null uitsluitend waar toegestaan.

currencyTekenreeksVerplicht

Valutacode voor het bedrag.

Beperkingen
pattern
"^[A-Z]{3}$"
minor_unitsGeheel getalVerplicht

Aantal decimalen van de valuta.

minimum: 0maximum: 4
totalsOrderTotalsData Verplicht

Totalen · net / tax / gross; Vóór kortingen / Na kortingen.

Velden · totals

Volledig model: OrderTotalsData

before_discountsOrderAmountBreakdownData Verplicht

Bestelling · Vóór kortingen · net / tax / gross.

discountsOrderAmountBreakdownData Verplicht

Kortingen

orderOrderAmountBreakdownData Verplicht

Bestelling · Na kortingen · net / tax / gross.

product_discountsOrderAmountBreakdownData Verplicht

Producten · Kortingen · net / tax / gross.

productsOrderAmountBreakdownData Verplicht

Producten · Na kortingen · net / tax / gross.

products_before_discountsOrderAmountBreakdownData Verplicht

Producten · Vóór kortingen · net / tax / gross.

shippingOrderAmountBreakdownData Verplicht

Verzending · Na kortingen · net / tax / gross.

shipping_before_discountsOrderAmountBreakdownData Verplicht

Verzending · Vóór kortingen · net / tax / gross.

shipping_discountsOrderAmountBreakdownData Verplicht

Verzending · Kortingen · net / tax / gross.

metaContextPageMeta ContextMeta PageMeta RequestMeta Verplicht

Metadata van het antwoord.

Velden · meta

ContextPageMeta

Volledig model: ContextPageMeta

localeTekenreeksVerplicht

Taal die voor dit verzoek is geselecteerd.

market_codeTekenreeksVerplicht

Marktcode die het contextendpoint teruggeeft.

market_idTekenreeksVerplicht

Marktidentificatie die het contextendpoint teruggeeft.

paginationPagination Verplicht

Metadata voor cursorpaginering.

request_idTekenreeksVerplicht

Aanvraagidentificatie; in antwoordmetadata identificeert dit het HTTP-verzoek.

minLength: 1maxLength: 100

ContextMeta

Volledig model: ContextMeta

localeTekenreeksVerplicht

Taal die voor dit verzoek is geselecteerd.

market_codeTekenreeksVerplicht

Marktcode die het contextendpoint teruggeeft.

market_idTekenreeksVerplicht

Marktidentificatie die het contextendpoint teruggeeft.

request_idTekenreeksVerplicht

Aanvraagidentificatie; in antwoordmetadata identificeert dit het HTTP-verzoek.

minLength: 1maxLength: 100

PageMeta

Volledig model: PageMeta

paginationPagination Verplicht

Metadata voor cursorpaginering.

request_idTekenreeksVerplicht

Aanvraagidentificatie; in antwoordmetadata identificeert dit het HTTP-verzoek.

minLength: 1maxLength: 100

RequestMeta

Volledig model: RequestMeta

request_idTekenreeksVerplicht

Aanvraagidentificatie; in antwoordmetadata identificeert dit het HTTP-verzoek.

minLength: 1maxLength: 100
Voorbeeldantwoord

HTTP-status

200
Geslaagd antwoord Schema
400
Ongeldig verzoek
401
Authenticatie vereist
403
Toegang geweigerd
404
Resource niet gevonden
409
Versieconflict
422
Validatie mislukt
429
Verzoeklimiet overschreden
Overige HTTP-statussen (7)
405
Methode niet toegestaan
413
Verzoek te groot
415
Niet-ondersteund formaat
500
Serverfout
502
API-gatewayfout
503
Service niet beschikbaar
504
Gatewaytime-out

Foutencatalogus: ErrorResponse

Headers

401

WWW-AuthenticateTekenreeksOptioneel

Authenticatieschema dat de server vereist.

405

AllowTekenreeksOptioneel

HTTP-methoden die deze resource ondersteunt.

429, 503

Retry-AfterGeheel getalOptioneel

Minimale wachttijd voordat u het opnieuw probeert, in seconden.

minimum: 0

Foutencatalogus · Meer informatie