Hent — Ordrer

Læs data fra ”Ordrer”. Resultatet afhænger af handlingens parametre.

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

Godkendelse: Bearer
Tilgængelig fra: BASIC
Nødvendige rettigheder: orders.order:read

Eksempel på forespørgsel

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

Eksempel på svar 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"
  }
}

Principper

Samlingen giver ordreoversigter og filtre for nummer, status, betalingsstatus og oprettelsestidspunkt.
Ordrelisten og detaljer indeholder delivery.dates. Datoer i YYYY-MM-DD er planlagte og bekræfter ikke afsendelse. Aktuelle datoer har forrang; ældre ordrer bruger det gemte estimat. Slettede eller ukendte værdier er null. Detaljer indeholder også alle ordrelinjer og produktbilleder.

Hent gyldige statusidentifikatorer fra /api/v1/order-statuses.
Ordrestatus og betalingsstatus bruger separate PATCH-endepunkter og rettigheder.
Ændring af den registrerede betalingsstatus trækker ikke penge på et kort og udløser ikke en refusion via en betalingsudbyder.

Sikre skriveoperationer

Rettigheder og abonnementer

Ordre · Totaler

Beløb og satser kommer fra den gemte ordre, inklusive rettelser af linjer. Manglende historiske oplysninger er null og erstattes ikke med katalogets aktuelle satser. Beløb forbliver decimalstrenge.

Listen returnerer oversigter. Hent GET /api/v1/orders/{order_id} for hvert resultat for at eksportere fulde økonomiske oplysninger. GET-forsøg er begrænsede og følger Retry-After. Eksport efter oprettelsesdato synkroniserer ikke senere rettelser.

tax_country_code · Skatteland · Gemte ordredata · ISO 3166-1 alpha-2; null.
lines[].unit_* · En enhed · Før rabatter; lines[].original_total_* · Før rabatter; lines[].total_* · Efter rabatter.
lines[].discount_* · Rabatter; manual_discount · Manuel rabat; percentage "10" = 10%.
delivery.net / tax / gross · Efter rabatter; delivery.original_* · Før rabatter; delivery.discount_* · Rabatter.
tax_rate: "0.23" = 23%; "0" ≠ null. Ukendt: null; kendt nul: 0.
totals · Totaler; tax_breakdown.groups · Skattegrupper; Ikke fordelt skat = order.tax − Σ groups.tax; ±.

payment.amount er ordretotalen. Betalingsstatus bestemmer ikke betalte, refunderede eller udestående beløb.

Parametre

Stiparametre

order_idStrengObligatorisk

Identifikator for den relaterede ordre.

Begrænsninger

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

Eksempel: "example"

Denne operation accepterer ikke JSON-indhold.

Svar

Svar 200

Fuld model: ApiResponse_OrderDetailData_

dataOrderDetailData Obligatorisk

Indholdet af et vellykket svar.

Felter · data

Fuld model: OrderDetailData

created_atStrengObligatorisk

Oprettelsestidspunkt.

format: "date-time"

customerCustomerData Obligatorisk

Kundeoplysninger registreret for denne ressource.

Felter · customer

Fuld model: CustomerData

emailStrengObligatorisk: E-mailadresse.
first_nameStreng nullObligatorisk: Fornavn.
last_nameStreng nullObligatorisk: Efternavn.
phoneStreng nullObligatorisk: Telefonnummer.

deliveryShippingDetailData Obligatorisk

Leveringsmetode og tilhørende oplysninger.

Felter · delivery

Fuld model: ShippingDetailData

amountMoneyData Obligatorisk

Decimalbeløb kodet som en JSON-streng; null kun hvor tilladt.

datesDeliveryDatesData Obligatorisk

Afsendelses- og leveringsdatoer

discount_grossMoneyData Obligatorisk

Bruttobeløb · Rabatter; Ukendt: null; kendt nul: 0.

discount_netMoneyData nullObligatorisk

Nettobeløb · Rabatter; Ukendt: null; kendt nul: 0.

discount_taxMoneyData nullObligatorisk

Skattebeløb · Rabatter; Ukendt: null; kendt nul: 0.

discountsArray <OrderDeliveryDiscountData > nullObligatorisk

Rabatter

grossMoneyData Obligatorisk

Bruttobeløb · Efter rabatter; Ukendt: null; kendt nul: 0.

method_codeStreng nullObligatorisk

Kode for leverings- eller betalingsmetode.

method_nameStreng nullObligatorisk

Navn på leverings- eller betalingsmetode.

netMoneyData nullObligatorisk

Nettobeløb · Efter rabatter; Ukendt: null; kendt nul: 0.

original_grossMoneyData Obligatorisk

Bruttobeløb · Fragt · Før rabatter; Ukendt: null; kendt nul: 0.

original_netMoneyData nullObligatorisk

Nettobeløb · Fragt · Før rabatter; Ukendt: null; kendt nul: 0.

original_taxMoneyData nullObligatorisk

Skattebeløb · Fragt · Før rabatter; Ukendt: null; kendt nul: 0.

pickup_pointDeliveryPickupPointData nullObligatorisk

Afhentningssted

recipient_modeStrengObligatorisk

Variant af datastrukturen beskrevet ved de tilladte værdier.

Begrænsninger

enum: ["full_address", "pickup_contact"]

taxMoneyData nullObligatorisk

Afgiftsoplysninger.

tax_category_idStreng nullObligatorisk

Identifikator for afgiftskategori.

tax_category_nameStreng nullObligatorisk

Gemt navn på skattekategorien; null.

tax_rateStreng nullObligatorisk

tax_rate · Gemte ordredata: "0.23" = 23%; "0" ≠ null.

discount_amountMoneyData Obligatorisk

Decimalbeløb kodet som en JSON-streng; null kun hvor tilladt.

Felter · discount_amount

Fuld model: MoneyData

amountStrengObligatorisk

Decimalbeløb kodet som en JSON-streng; null kun hvor tilladt.

currencyStrengObligatorisk

Valutakode for beløbet.

Begrænsninger

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

minor_unitsHeltalObligatorisk

Antal decimaler, som valutaen bruger.

minimum: 0maximum: 4

discountsArray <OrderDiscountData > Obligatorisk

Rabatter

Felter · discounts

OrderDiscountData

Fuld model: OrderDiscountData

idStrengObligatorisk

Ressourceidentifikator; bevar den som returneret.

invoiceInvoiceData nullObligatorisk

Fakturaoplysninger.

Felter · invoice

InvoiceData

Fuld model: InvoiceData

null

invoice_requestedBoolesk værdiObligatorisk

Om der blev anmodet om en faktura.

lifecycle_stateOrderLifecycleState Obligatorisk

Tilstand i forretningslivscyklussen.

linesArray <OrderLineData > Obligatorisk

Øjebliksbilleder af ordrelinjer.

Felter · lines

OrderLineData

Fuld model: OrderLineData

localeStrengObligatorisk

Sprog valgt til denne forespørgsel.

market_idStrengObligatorisk

Markedsidentifikator returneret af kontekstendepunktet.

numberStrengObligatorisk

Ordre- eller sagsnummer beregnet til mennesker.

paymentPaymentData Obligatorisk

Betalingsoplysninger registreret for ordren.

Felter · payment

Fuld model: PaymentData

amountMoneyData Obligatorisk

Decimalbeløb kodet som en JSON-streng; null kun hvor tilladt.

environmentStrengObligatorisk

Miljøoplysninger knyttet til posten.

Begrænsninger

enum: ["live", "sandbox"]

method_codeStreng nullObligatorisk

Kode for leverings- eller betalingsmetode.

method_nameStreng nullObligatorisk

Navn på leverings- eller betalingsmetode.

paid_atStreng nullObligatorisk

Dato og tidspunkt, hvor betalingen blev markeret som betalt.

Streng:format: "date-time"

statusOrderPaymentStatus Obligatorisk

Status accepteret af denne specifikke operation.

updated_atStrengObligatorisk

Tidspunkt for seneste opdatering.

format: "date-time"

versionHeltalObligatorisk

Ressourceversion anvendt til samtidighedskontrol.

pickup_pointPickupPointData nullObligatorisk

Afhentningssted

Felter · pickup_point

PickupPointData

Fuld model: PickupPointData

null

prices_include_taxBoolesk værdiObligatorisk

Om de angivne priser inkluderer afgifter.

shipping_addressAddressData nullObligatorisk

Leveringsadresse.

Felter · shipping_address

AddressData

Fuld model: AddressData

null

shipping_discount_amountMoneyData Obligatorisk

Decimalbeløb kodet som en JSON-streng; null kun hvor tilladt.

Felter · shipping_discount_amount

Fuld model: MoneyData

amountStrengObligatorisk

Decimalbeløb kodet som en JSON-streng; null kun hvor tilladt.

currencyStrengObligatorisk

Valutakode for beløbet.

Begrænsninger

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

minor_unitsHeltalObligatorisk

Antal decimaler, som valutaen bruger.

minimum: 0maximum: 4

statusOrderStatusData Obligatorisk

Status accepteret af denne specifikke operation.

Felter · status

Fuld model: OrderStatusData

idStrengObligatorisk: Ressourceidentifikator; bevar den som returneret.
nameStrengObligatorisk: Ressourcens navn i den relevante kontekst.
updated_atStrengObligatorisk: Tidspunkt for seneste opdatering.
format: "date-time"
versionHeltalObligatorisk: Ressourceversion anvendt til samtidighedskontrol.

subtotalMoneyData Obligatorisk

Beløb før de yderligere bestanddele vist i svaret.

Felter · subtotal

Fuld model: MoneyData

amountStrengObligatorisk

Decimalbeløb kodet som en JSON-streng; null kun hvor tilladt.

currencyStrengObligatorisk

Valutakode for beløbet.

Begrænsninger

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

minor_unitsHeltalObligatorisk

Antal decimaler, som valutaen bruger.

minimum: 0maximum: 4

taxMoneyData Obligatorisk

Afgiftsoplysninger.

Felter · tax

Fuld model: MoneyData

amountStrengObligatorisk

Decimalbeløb kodet som en JSON-streng; null kun hvor tilladt.

currencyStrengObligatorisk

Valutakode for beløbet.

Begrænsninger

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

minor_unitsHeltalObligatorisk

Antal decimaler, som valutaen bruger.

minimum: 0maximum: 4

tax_breakdownOrderTaxBreakdownData Obligatorisk

Skattegrupper · source + tax_rate; unallocated_tax.

Felter · tax_breakdown

Fuld model: OrderTaxBreakdownData

groupsArray <OrderTaxGroupData > Obligatorisk: Skattegrupper · source + tax_rate; Ukendt: null; kendt nul: 0.
unallocated_taxMoneyData Obligatorisk: Ikke fordelt skat = order.tax − Σ groups.tax; ±.

tax_country_codeStreng nullObligatorisk

Skatteland · Gemte ordredata · ISO 3166-1 alpha-2; null.

totalMoneyData Obligatorisk

Samlet beløb.

Felter · total

Fuld model: MoneyData

amountStrengObligatorisk

Decimalbeløb kodet som en JSON-streng; null kun hvor tilladt.

currencyStrengObligatorisk

Valutakode for beløbet.

Begrænsninger

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

minor_unitsHeltalObligatorisk

Antal decimaler, som valutaen bruger.

minimum: 0maximum: 4

totalsOrderTotalsData Obligatorisk

Totaler · net / tax / gross; Før rabatter / Efter rabatter.

Felter · totals

Fuld model: OrderTotalsData

before_discountsOrderAmountBreakdownData Obligatorisk: Ordre · Før rabatter · net / tax / gross.
discountsOrderAmountBreakdownData Obligatorisk: Rabatter
orderOrderAmountBreakdownData Obligatorisk: Ordre · Efter rabatter · net / tax / gross.
product_discountsOrderAmountBreakdownData Obligatorisk: Produkter · Rabatter · net / tax / gross.
productsOrderAmountBreakdownData Obligatorisk: Produkter · Efter rabatter · net / tax / gross.
products_before_discountsOrderAmountBreakdownData Obligatorisk: Produkter · Før rabatter · net / tax / gross.
shippingOrderAmountBreakdownData Obligatorisk: Fragt · Efter rabatter · net / tax / gross.
shipping_before_discountsOrderAmountBreakdownData Obligatorisk: Fragt · Før rabatter · net / tax / gross.
shipping_discountsOrderAmountBreakdownData Obligatorisk: Fragt · Rabatter · net / tax / gross.

metaContextPageMeta ContextMeta PageMeta RequestMeta Obligatorisk

Svarmetadata.

Felter · meta

ContextPageMeta

Fuld model: ContextPageMeta

localeStrengObligatorisk: Sprog valgt til denne forespørgsel.
market_codeStrengObligatorisk: Markedskode returneret af kontekstendepunktet.
market_idStrengObligatorisk: Markedsidentifikator returneret af kontekstendepunktet.
paginationPagination Obligatorisk: Metadata for markørbaseret sideinddeling.
request_idStrengObligatorisk: Sagsidentifikator; i svarmetadata identificerer den HTTP-forespørgslen.
minLength: 1maxLength: 100

ContextMeta

Fuld model: ContextMeta

localeStrengObligatorisk: Sprog valgt til denne forespørgsel.
market_codeStrengObligatorisk: Markedskode returneret af kontekstendepunktet.
market_idStrengObligatorisk: Markedsidentifikator returneret af kontekstendepunktet.
request_idStrengObligatorisk: Sagsidentifikator; i svarmetadata identificerer den HTTP-forespørgslen.
minLength: 1maxLength: 100

PageMeta

Fuld model: PageMeta

paginationPagination Obligatorisk: Metadata for markørbaseret sideinddeling.
request_idStrengObligatorisk: Sagsidentifikator; i svarmetadata identificerer den HTTP-forespørgslen.
minLength: 1maxLength: 100

RequestMeta

Fuld model: RequestMeta

request_idStrengObligatorisk: Sagsidentifikator; i svarmetadata identificerer den HTTP-forespørgslen.
minLength: 1maxLength: 100

Eksempel på svar

HTTP-status

200: Vellykket svar Skema
400: Ugyldig anmodning
401: Godkendelse påkrævet
403: Adgang nægtet
404: Ressource ikke fundet
409: Versionskonflikt
422: Validering mislykkedes
429: Grænsen for anmodninger er overskredet

Andre HTTP-statusser (7)

405: Metoden er ikke tilladt
413: Anmodningen er for stor
415: Formatet understøttes ikke
500: Serverfejl
502: Fejl i API-gateway
503: Tjenesten er utilgængelig
504: Tidsgrænsen er overskredet

Fejlkatalog: ErrorResponse

Headere

401

WWW-AuthenticateStrengValgfrit: Godkendelsesmetode, som serveren kræver.

405

AllowStrengValgfrit: HTTP-metoder, som denne ressource understøtter.

429, 503

Retry-AfterHeltalValgfrit: Mindste ventetid før næste forsøg, i sekunder.

minimum: 0

Fejlkatalog · Læs mere

GET/api/v1/orders/{order_id}

Kodeeksempler

Eksempel på forespørgsel

cURL

PHP

Python

Eksempel på svar 200

Principper

Ordre · Totaler

Parametre

Stiparametre

Svar

Svar 200

HTTP-status

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