Gå til innhold
ShopentlyLearn
Norsk bokmål

Hent — Ordrer

Les data fra «Ordrer». Resultatet avhenger av parameterne for operasjonen.

GET/api/v1/orders/{order_id}

Autentisering
Bearer
Tilgjengelig fra
BASIC
Nødvendige tilganger
orders.order:read

Kodeeksempler

Eksempel på forespørsel

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

Prinsipper

  • Samlingen gir ordreoversikter og filtre for nummer, status, betalingsstatus og opprettelsestidspunkt.
  • Ordrelisten og detaljene inneholder delivery.dates. Datoer i YYYY-MM-DD er planlagte og bekrefter ikke forsendelse. Gjeldende datoer har forrang; eldre ordrer bruker det lagrede estimatet. Slettede eller ukjente verdier er null. Detaljene inneholder også alle ordrelinjer og produktbilder.
  • Hent gyldige statusidentifikatorer fra /api/v1/order-statuses.
  • Ordrestatus og betalingsstatus bruker separate PATCH-endepunkter og tilganger.
  • Endring av registrert betalingsstatus belaster ikke et kort og utløser ikke refusjon gjennom en betalingsleverandør.

Trygge skriveoperasjoner

Tilganger og abonnementer

Ordre · Totalsummer

Beløp og satser kommer fra den lagrede ordren, inkludert linjerettelser. Manglende historiske opplysninger er null og erstattes ikke med katalogens gjeldende satser. Beløp forblir desimalstrenger.

Listen returnerer sammendrag. Hent GET /api/v1/orders/{order_id} for hvert resultat for å eksportere fullstendige økonomiske opplysninger. GET-forsøk er begrenset og følger Retry-After. Eksport etter opprettelsesdato synkroniserer ikke senere rettelser.

  • tax_country_code · Avgiftsland · Lagrede ordredata · ISO 3166-1 alpha-2; null.
  • lines[].unit_* · Én enhet · Før rabatter; lines[].original_total_* · Før rabatter; lines[].total_* · Etter rabatter.
  • lines[].discount_* · Rabatter; manual_discount · Manuell rabatt; percentage "10" = 10%.
  • delivery.net / tax / gross · Etter rabatter; delivery.original_* · Før rabatter; delivery.discount_* · Rabatter.
  • tax_rate: "0.23" = 23%; "0" ≠ null. Ukjent: null; kjent nullverdi: 0.
  • totals · Totalsummer; tax_breakdown.groups · Avgiftsgrupper; Ufordelt avgift = order.tax − Σ groups.tax; ±.

payment.amount er ordretotalen. Betalingsstatus bestemmer ikke betalte, refunderte eller utestående beløp.

Parametere

Stiparametere

order_idStrengObligatorisk

Identifikator for tilknyttet ordre.

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

Denne operasjonen godtar ikke JSON-innhold.

Svar

Svar 200

Fullstendig modell: ApiResponse_OrderDetailData_

dataOrderDetailData Obligatorisk

Innholdet i et vellykket svar.

Felter · data

Fullstendig modell: OrderDetailData

created_atStrengObligatorisk

Opprettelsestidspunkt.

format: "date-time"
customerCustomerData Obligatorisk

Kundeinformasjon registrert for denne ressursen.

Felter · customer

Fullstendig modell: CustomerData

emailStrengObligatorisk

E-postadresse.

first_nameStreng nullObligatorisk

Fornavn.

last_nameStreng nullObligatorisk

Etternavn.

phoneStreng nullObligatorisk

Telefonnummer.

deliveryShippingDetailData Obligatorisk

Leveringsmetode og tilhørende informasjon.

Felter · delivery

Fullstendig modell: ShippingDetailData

amountMoneyData Obligatorisk

Desimalbeløp kodet som en JSON-streng; null bare der det er tillatt.

datesDeliveryDatesData Obligatorisk

Forsendelses- og leveringsdatoer

discount_grossMoneyData Obligatorisk

Bruttobeløp · Rabatter; Ukjent: null; kjent nullverdi: 0.

discount_netMoneyData nullObligatorisk

Nettobeløp · Rabatter; Ukjent: null; kjent nullverdi: 0.

discount_taxMoneyData nullObligatorisk

Avgiftsbeløp · Rabatter; Ukjent: null; kjent nullverdi: 0.

discountsArray <OrderDeliveryDiscountData > nullObligatorisk

Rabatter

grossMoneyData Obligatorisk

Bruttobeløp · Etter rabatter; Ukjent: null; kjent nullverdi: 0.

method_codeStreng nullObligatorisk

Kode for leverings- eller betalingsmetode.

method_nameStreng nullObligatorisk

Navn på leverings- eller betalingsmetode.

netMoneyData nullObligatorisk

Nettobeløp · Etter rabatter; Ukjent: null; kjent nullverdi: 0.

original_grossMoneyData Obligatorisk

Bruttobeløp · Frakt · Før rabatter; Ukjent: null; kjent nullverdi: 0.

original_netMoneyData nullObligatorisk

Nettobeløp · Frakt · Før rabatter; Ukjent: null; kjent nullverdi: 0.

original_taxMoneyData nullObligatorisk

Avgiftsbeløp · Frakt · Før rabatter; Ukjent: null; kjent nullverdi: 0.

pickup_pointDeliveryPickupPointData nullObligatorisk

Hentested

recipient_modeStrengObligatorisk

Variant av datastrukturen beskrevet av de tillatte verdiene.

Begrensninger
enum
["full_address", "pickup_contact"]
taxMoneyData nullObligatorisk

Avgiftsinformasjon.

tax_category_idStreng nullObligatorisk

Identifikator for avgiftskategori.

tax_category_nameStreng nullObligatorisk

Lagret navn på avgiftskategorien; null.

tax_rateStreng nullObligatorisk

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

discount_amountMoneyData Obligatorisk

Desimalbeløp kodet som en JSON-streng; null bare der det er tillatt.

Felter · discount_amount

Fullstendig modell: MoneyData

amountStrengObligatorisk

Desimalbeløp kodet som en JSON-streng; null bare der det er tillatt.

currencyStrengObligatorisk

Valutakode for beløpet.

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

Antall desimalsifre valutaen bruker.

minimum: 0maximum: 4
discountsArray <OrderDiscountData > Obligatorisk

Rabatter

Felter · discounts

OrderDiscountData

Fullstendig modell: OrderDiscountData

idStrengObligatorisk

Ressursidentifikator; behold den slik den returneres.

invoiceInvoiceData nullObligatorisk

Fakturainformasjon.

Felter · invoice

InvoiceData

Fullstendig modell: InvoiceData

null

invoice_requestedBoolsk verdiObligatorisk

Om det ble bedt om faktura.

lifecycle_stateOrderLifecycleState Obligatorisk

Tilstand i forretningslivssyklusen.

linesArray <OrderLineData > Obligatorisk

Øyeblikksbilder av ordrelinjer.

Felter · lines

OrderLineData

Fullstendig modell: OrderLineData

localeStrengObligatorisk

Språk valgt for denne forespørselen.

market_idStrengObligatorisk

Markedsidentifikator returnert av kontekstendepunktet.

numberStrengObligatorisk

Ordre- eller saksnummer beregnet på mennesker.

paymentPaymentData Obligatorisk

Betalingsopplysninger registrert for ordren.

Felter · payment

Fullstendig modell: PaymentData

amountMoneyData Obligatorisk

Desimalbeløp kodet som en JSON-streng; null bare der det er tillatt.

environmentStrengObligatorisk

Miljøinformasjon knyttet til oppføringen.

Begrensninger
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 da betalingen ble merket som betalt.

Streng:format: "date-time"
statusOrderPaymentStatus Obligatorisk

Status som godtas av denne bestemte operasjonen.

updated_atStrengObligatorisk

Tidspunkt for siste oppdatering.

format: "date-time"
versionHeltallObligatorisk

Ressursversjon brukt til samtidighetskontroll.

pickup_pointPickupPointData nullObligatorisk

Hentested

Felter · pickup_point

PickupPointData

Fullstendig modell: PickupPointData

null

prices_include_taxBoolsk verdiObligatorisk

Om oppgitte priser inkluderer avgifter.

shipping_addressAddressData nullObligatorisk

Leveringsadresse.

Felter · shipping_address

AddressData

Fullstendig modell: AddressData

null

shipping_discount_amountMoneyData Obligatorisk

Desimalbeløp kodet som en JSON-streng; null bare der det er tillatt.

Felter · shipping_discount_amount

Fullstendig modell: MoneyData

amountStrengObligatorisk

Desimalbeløp kodet som en JSON-streng; null bare der det er tillatt.

currencyStrengObligatorisk

Valutakode for beløpet.

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

Antall desimalsifre valutaen bruker.

minimum: 0maximum: 4
statusOrderStatusData Obligatorisk

Status som godtas av denne bestemte operasjonen.

Felter · status

Fullstendig modell: OrderStatusData

idStrengObligatorisk

Ressursidentifikator; behold den slik den returneres.

nameStrengObligatorisk

Ressursens navn i den relevante konteksten.

updated_atStrengObligatorisk

Tidspunkt for siste oppdatering.

format: "date-time"
versionHeltallObligatorisk

Ressursversjon brukt til samtidighetskontroll.

subtotalMoneyData Obligatorisk

Beløp før de ytterligere bestanddelene vist i svaret.

Felter · subtotal

Fullstendig modell: MoneyData

amountStrengObligatorisk

Desimalbeløp kodet som en JSON-streng; null bare der det er tillatt.

currencyStrengObligatorisk

Valutakode for beløpet.

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

Antall desimalsifre valutaen bruker.

minimum: 0maximum: 4
taxMoneyData Obligatorisk

Avgiftsinformasjon.

Felter · tax

Fullstendig modell: MoneyData

amountStrengObligatorisk

Desimalbeløp kodet som en JSON-streng; null bare der det er tillatt.

currencyStrengObligatorisk

Valutakode for beløpet.

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

Antall desimalsifre valutaen bruker.

minimum: 0maximum: 4
tax_breakdownOrderTaxBreakdownData Obligatorisk

Avgiftsgrupper · source + tax_rate; unallocated_tax.

Felter · tax_breakdown

Fullstendig modell: OrderTaxBreakdownData

groupsArray <OrderTaxGroupData > Obligatorisk

Avgiftsgrupper · source + tax_rate; Ukjent: null; kjent nullverdi: 0.

unallocated_taxMoneyData Obligatorisk

Ufordelt avgift = order.tax − Σ groups.tax; ±.

tax_country_codeStreng nullObligatorisk

Avgiftsland · Lagrede ordredata · ISO 3166-1 alpha-2; null.

totalMoneyData Obligatorisk

Samlet beløp.

Felter · total

Fullstendig modell: MoneyData

amountStrengObligatorisk

Desimalbeløp kodet som en JSON-streng; null bare der det er tillatt.

currencyStrengObligatorisk

Valutakode for beløpet.

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

Antall desimalsifre valutaen bruker.

minimum: 0maximum: 4
totalsOrderTotalsData Obligatorisk

Totalsummer · net / tax / gross; Før rabatter / Etter rabatter.

Felter · totals

Fullstendig modell: OrderTotalsData

before_discountsOrderAmountBreakdownData Obligatorisk

Ordre · Før rabatter · net / tax / gross.

discountsOrderAmountBreakdownData Obligatorisk

Rabatter

orderOrderAmountBreakdownData Obligatorisk

Ordre · Etter rabatter · net / tax / gross.

product_discountsOrderAmountBreakdownData Obligatorisk

Produkter · Rabatter · net / tax / gross.

productsOrderAmountBreakdownData Obligatorisk

Produkter · Etter rabatter · net / tax / gross.

products_before_discountsOrderAmountBreakdownData Obligatorisk

Produkter · Før rabatter · net / tax / gross.

shippingOrderAmountBreakdownData Obligatorisk

Frakt · Etter rabatter · net / tax / gross.

shipping_before_discountsOrderAmountBreakdownData Obligatorisk

Frakt · Før rabatter · net / tax / gross.

shipping_discountsOrderAmountBreakdownData Obligatorisk

Frakt · Rabatter · net / tax / gross.

metaContextPageMeta ContextMeta PageMeta RequestMeta Obligatorisk

Svarmetadata.

Felter · meta

ContextPageMeta

Fullstendig modell: ContextPageMeta

localeStrengObligatorisk

Språk valgt for denne forespørselen.

market_codeStrengObligatorisk

Markedskode returnert av kontekstendepunktet.

market_idStrengObligatorisk

Markedsidentifikator returnert av kontekstendepunktet.

paginationPagination Obligatorisk

Metadata for markørbasert sideinndeling.

request_idStrengObligatorisk

Saksidentifikator; i svarmetadata identifiserer den HTTP-forespørselen.

minLength: 1maxLength: 100

ContextMeta

Fullstendig modell: ContextMeta

localeStrengObligatorisk

Språk valgt for denne forespørselen.

market_codeStrengObligatorisk

Markedskode returnert av kontekstendepunktet.

market_idStrengObligatorisk

Markedsidentifikator returnert av kontekstendepunktet.

request_idStrengObligatorisk

Saksidentifikator; i svarmetadata identifiserer den HTTP-forespørselen.

minLength: 1maxLength: 100

PageMeta

Fullstendig modell: PageMeta

paginationPagination Obligatorisk

Metadata for markørbasert sideinndeling.

request_idStrengObligatorisk

Saksidentifikator; i svarmetadata identifiserer den HTTP-forespørselen.

minLength: 1maxLength: 100

RequestMeta

Fullstendig modell: RequestMeta

request_idStrengObligatorisk

Saksidentifikator; i svarmetadata identifiserer den HTTP-forespørselen.

minLength: 1maxLength: 100
Eksempel på svar

HTTP-status

200
Vellykket svar Skjema
400
Ugyldig forespørsel
401
Autentisering kreves
403
Tilgang nektet
404
Ressursen ble ikke funnet
409
Versjonskonflikt
422
Validering mislyktes
429
Forespørselsgrensen er overskredet
Andre HTTP-statuser (7)
405
Metoden er ikke tillatt
413
Forespørselen er for stor
415
Formatet støttes ikke
500
Serverfeil
502
Feil i API-gateway
503
Tjenesten er utilgjengelig
504
Tidsavbrudd

Feilkatalog: ErrorResponse

Headere

401

WWW-AuthenticateStrengValgfritt

Autentiseringsmetode serveren krever.

405

AllowStrengValgfritt

HTTP-metoder denne ressursen støtter.

429, 503

Retry-AfterHeltallValgfritt

Minste ventetid før neste forsøk, i sekunder.

minimum: 0

Feilkatalog · Les mer