Hoppa till innehållet
ShopentlyLearn
Svenska

Hämta — Beställningar

Läs data från ”Beställningar”. Resultatet beror på åtgärdens parametrar.

GET/api/v1/orders/{order_id}

Autentisering
Bearer
Tillgänglig från
BASIC
Behörigheter som krävs
orders.order:read

Kodexempel

Exempel på begäran

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

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

Så fungerar det

  • Samlingen innehåller sammanfattningar och filter för nummer, status, betalningsstatus och tidpunkt för skapande.
  • Orderlistan och detaljerna innehåller delivery.dates. Datum i YYYY-MM-DD är planerade och bekräftar inte avsändning. Aktuella datum har företräde; äldre beställningar använder den sparade uppskattningen. Raderade eller okända värden är null. Detaljerna innehåller även alla orderrader och produktbilder.
  • Hämta giltiga statusidentifierare från /api/v1/order-statuses.
  • Beställningsstatus och betalningsstatus har separata PATCH-endpoints och behörigheter.
  • Att ändra registrerad betalningsstatus debiterar inte ett kort och genomför ingen återbetalning via en betalningsleverantör.

Säkra skrivningar

Behörigheter och abonnemang

Beställning · Summor

Belopp och skattesatser kommer från den sparade ordern, inklusive radkorrigeringar. Saknade historiska uppgifter är null och ersätts inte med aktuella katalogsatser. Belopp förblir decimalsträngar.

Listan returnerar sammanfattningar. Hämta GET /api/v1/orders/{order_id} för varje resultat för att exportera fullständiga ekonomiska uppgifter. GET-försök är begränsade och följer Retry-After. Export efter skapandedatum synkroniserar inte senare korrigeringar.

  • tax_country_code · Skatteland · Sparade orderuppgifter · ISO 3166-1 alpha-2; null.
  • lines[].unit_* · En enhet · Före rabatter; lines[].original_total_* · Före rabatter; lines[].total_* · Efter rabatter.
  • lines[].discount_* · Rabatter; manual_discount · Manuell rabatt; percentage "10" = 10%.
  • delivery.net / tax / gross · Efter rabatter; delivery.original_* · Före rabatter; delivery.discount_* · Rabatter.
  • tax_rate: "0.23" = 23%; "0" ≠ null. Okänt: null; känt nollvärde: 0.
  • totals · Summor; tax_breakdown.groups · Skattegrupper; Ej fördelad skatt = order.tax − Σ groups.tax; ±.

payment.amount är orderns totalbelopp. Betalningsstatus avgör inte betalda, återbetalda eller återstående belopp.

Parametrar

Sökvägsparametrar

order_idSträngObligatoriskt

Identifierare för tillhörande beställning.

Begränsningar
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Exempel: "example"

Den här operationen tar inte emot JSON-innehåll.

Svar

Svar 200

Fullständig modell: ApiResponse_OrderDetailData_

dataOrderDetailData Obligatoriskt

Innehållet i ett lyckat svar.

Fält · data

Fullständig modell: OrderDetailData

created_atSträngObligatoriskt

Tidpunkt för skapande.

format: "date-time"
customerCustomerData Obligatoriskt

Kunduppgifter registrerade för resursen.

Fält · customer

Fullständig modell: CustomerData

emailSträngObligatoriskt

E-postadress.

first_nameSträng nullObligatoriskt

Förnamn.

last_nameSträng nullObligatoriskt

Efternamn.

phoneSträng nullObligatoriskt

Telefonnummer.

deliveryShippingDetailData Obligatoriskt

Leveranssätt och tillhörande information.

Fält · delivery

Fullständig modell: ShippingDetailData

amountMoneyData Obligatoriskt

Decimalbelopp kodat som JSON-sträng; null endast där det tillåts.

datesDeliveryDatesData Obligatoriskt

Avsändnings- och leveransdatum

discount_grossMoneyData Obligatoriskt

Bruttobelopp · Rabatter; Okänt: null; känt nollvärde: 0.

discount_netMoneyData nullObligatoriskt

Nettobelopp · Rabatter; Okänt: null; känt nollvärde: 0.

discount_taxMoneyData nullObligatoriskt

Skattebelopp · Rabatter; Okänt: null; känt nollvärde: 0.

discountsArray <OrderDeliveryDiscountData > nullObligatoriskt

Rabatter

grossMoneyData Obligatoriskt

Bruttobelopp · Efter rabatter; Okänt: null; känt nollvärde: 0.

method_codeSträng nullObligatoriskt

Kod för leverans- eller betalningsmetod.

method_nameSträng nullObligatoriskt

Namn på leverans- eller betalningsmetod.

netMoneyData nullObligatoriskt

Nettobelopp · Efter rabatter; Okänt: null; känt nollvärde: 0.

original_grossMoneyData Obligatoriskt

Bruttobelopp · Frakt · Före rabatter; Okänt: null; känt nollvärde: 0.

original_netMoneyData nullObligatoriskt

Nettobelopp · Frakt · Före rabatter; Okänt: null; känt nollvärde: 0.

original_taxMoneyData nullObligatoriskt

Skattebelopp · Frakt · Före rabatter; Okänt: null; känt nollvärde: 0.

pickup_pointDeliveryPickupPointData nullObligatoriskt

Utlämningsställe

recipient_modeSträngObligatoriskt

Variant av datastrukturen, enligt dess tillåtna värden.

Begränsningar
enum
["full_address", "pickup_contact"]
taxMoneyData nullObligatoriskt

Skatteinformation.

tax_category_idSträng nullObligatoriskt

Skattekategorins identifierare.

tax_category_nameSträng nullObligatoriskt

Sparat namn på skattekategorin; null.

tax_rateSträng nullObligatoriskt

tax_rate · Sparade orderuppgifter: "0.23" = 23%; "0" ≠ null.

discount_amountMoneyData Obligatoriskt

Decimalbelopp kodat som JSON-sträng; null endast där det tillåts.

Fält · discount_amount

Fullständig modell: MoneyData

amountSträngObligatoriskt

Decimalbelopp kodat som JSON-sträng; null endast där det tillåts.

currencySträngObligatoriskt

Valutakod för beloppet.

Begränsningar
pattern
"^[A-Z]{3}$"
minor_unitsHeltalObligatoriskt

Antal decimaler som används för valutan.

minimum: 0maximum: 4
discountsArray <OrderDiscountData > Obligatoriskt

Rabatter

Fält · discounts

OrderDiscountData

Fullständig modell: OrderDiscountData

idSträngObligatoriskt

Resursens identifierare; bevara den som den returneras.

invoiceInvoiceData nullObligatoriskt

Fakturauppgifter.

Fält · invoice

InvoiceData

Fullständig modell: InvoiceData

null

invoice_requestedBooleskt värdeObligatoriskt

Anger om en faktura begärdes.

lifecycle_stateOrderLifecycleState Obligatoriskt

Status i affärslivscykeln.

linesArray <OrderLineData > Obligatoriskt

Sparade uppgifter för orderrader.

Fält · lines

OrderLineData

Fullständig modell: OrderLineData

localeSträngObligatoriskt

Språk valt för denna begäran.

market_idSträngObligatoriskt

Marknadsidentifierare returnerad av kontextendpointen.

numberSträngObligatoriskt

Beställnings- eller ärendenummer som visas för användaren.

paymentPaymentData Obligatoriskt

Betalningsuppgifter registrerade för beställningen.

Fält · payment

Fullständig modell: PaymentData

amountMoneyData Obligatoriskt

Decimalbelopp kodat som JSON-sträng; null endast där det tillåts.

environmentSträngObligatoriskt

Miljöinformation som hör till posten.

Begränsningar
enum
["live", "sandbox"]
method_codeSträng nullObligatoriskt

Kod för leverans- eller betalningsmetod.

method_nameSträng nullObligatoriskt

Namn på leverans- eller betalningsmetod.

paid_atSträng nullObligatoriskt

Datum och tid när betalningen markerades som betald.

Sträng:format: "date-time"
statusOrderPaymentStatus Obligatoriskt

Status som accepteras av den aktuella operationen.

updated_atSträngObligatoriskt

Tidpunkt för senaste uppdatering.

format: "date-time"
versionHeltalObligatoriskt

Resursversion för samtidighetskontroll.

pickup_pointPickupPointData nullObligatoriskt

Utlämningsställe

Fält · pickup_point

PickupPointData

Fullständig modell: PickupPointData

null

prices_include_taxBooleskt värdeObligatoriskt

Anger om angivna priser inkluderar skatt.

shipping_addressAddressData nullObligatoriskt

Leveransadress.

Fält · shipping_address

AddressData

Fullständig modell: AddressData

null

shipping_discount_amountMoneyData Obligatoriskt

Decimalbelopp kodat som JSON-sträng; null endast där det tillåts.

Fält · shipping_discount_amount

Fullständig modell: MoneyData

amountSträngObligatoriskt

Decimalbelopp kodat som JSON-sträng; null endast där det tillåts.

currencySträngObligatoriskt

Valutakod för beloppet.

Begränsningar
pattern
"^[A-Z]{3}$"
minor_unitsHeltalObligatoriskt

Antal decimaler som används för valutan.

minimum: 0maximum: 4
statusOrderStatusData Obligatoriskt

Status som accepteras av den aktuella operationen.

Fält · status

Fullständig modell: OrderStatusData

idSträngObligatoriskt

Resursens identifierare; bevara den som den returneras.

nameSträngObligatoriskt

Resursens namn i aktuell kontext.

updated_atSträngObligatoriskt

Tidpunkt för senaste uppdatering.

format: "date-time"
versionHeltalObligatoriskt

Resursversion för samtidighetskontroll.

subtotalMoneyData Obligatoriskt

Belopp före de tillägg som visas i svaret.

Fält · subtotal

Fullständig modell: MoneyData

amountSträngObligatoriskt

Decimalbelopp kodat som JSON-sträng; null endast där det tillåts.

currencySträngObligatoriskt

Valutakod för beloppet.

Begränsningar
pattern
"^[A-Z]{3}$"
minor_unitsHeltalObligatoriskt

Antal decimaler som används för valutan.

minimum: 0maximum: 4
taxMoneyData Obligatoriskt

Skatteinformation.

Fält · tax

Fullständig modell: MoneyData

amountSträngObligatoriskt

Decimalbelopp kodat som JSON-sträng; null endast där det tillåts.

currencySträngObligatoriskt

Valutakod för beloppet.

Begränsningar
pattern
"^[A-Z]{3}$"
minor_unitsHeltalObligatoriskt

Antal decimaler som används för valutan.

minimum: 0maximum: 4
tax_breakdownOrderTaxBreakdownData Obligatoriskt

Skattegrupper · source + tax_rate; unallocated_tax.

Fält · tax_breakdown

Fullständig modell: OrderTaxBreakdownData

groupsArray <OrderTaxGroupData > Obligatoriskt

Skattegrupper · source + tax_rate; Okänt: null; känt nollvärde: 0.

unallocated_taxMoneyData Obligatoriskt

Ej fördelad skatt = order.tax − Σ groups.tax; ±.

tax_country_codeSträng nullObligatoriskt

Skatteland · Sparade orderuppgifter · ISO 3166-1 alpha-2; null.

totalMoneyData Obligatoriskt

Totalbelopp.

Fält · total

Fullständig modell: MoneyData

amountSträngObligatoriskt

Decimalbelopp kodat som JSON-sträng; null endast där det tillåts.

currencySträngObligatoriskt

Valutakod för beloppet.

Begränsningar
pattern
"^[A-Z]{3}$"
minor_unitsHeltalObligatoriskt

Antal decimaler som används för valutan.

minimum: 0maximum: 4
totalsOrderTotalsData Obligatoriskt

Summor · net / tax / gross; Före rabatter / Efter rabatter.

Fält · totals

Fullständig modell: OrderTotalsData

before_discountsOrderAmountBreakdownData Obligatoriskt

Beställning · Före rabatter · net / tax / gross.

discountsOrderAmountBreakdownData Obligatoriskt

Rabatter

orderOrderAmountBreakdownData Obligatoriskt

Beställning · Efter rabatter · net / tax / gross.

product_discountsOrderAmountBreakdownData Obligatoriskt

Produkter · Rabatter · net / tax / gross.

productsOrderAmountBreakdownData Obligatoriskt

Produkter · Efter rabatter · net / tax / gross.

products_before_discountsOrderAmountBreakdownData Obligatoriskt

Produkter · Före rabatter · net / tax / gross.

shippingOrderAmountBreakdownData Obligatoriskt

Frakt · Efter rabatter · net / tax / gross.

shipping_before_discountsOrderAmountBreakdownData Obligatoriskt

Frakt · Före rabatter · net / tax / gross.

shipping_discountsOrderAmountBreakdownData Obligatoriskt

Frakt · Rabatter · net / tax / gross.

metaContextPageMeta ContextMeta PageMeta RequestMeta Obligatoriskt

Metadata för svaret.

Fält · meta

ContextPageMeta

Fullständig modell: ContextPageMeta

localeSträngObligatoriskt

Språk valt för denna begäran.

market_codeSträngObligatoriskt

Marknadskod returnerad av kontextendpointen.

market_idSträngObligatoriskt

Marknadsidentifierare returnerad av kontextendpointen.

paginationPagination Obligatoriskt

Metadata för markörbaserad paginering.

request_idSträngObligatoriskt

Ärendets identifierare; i svarsmetadata identifierar detta HTTP-begäran.

minLength: 1maxLength: 100

ContextMeta

Fullständig modell: ContextMeta

localeSträngObligatoriskt

Språk valt för denna begäran.

market_codeSträngObligatoriskt

Marknadskod returnerad av kontextendpointen.

market_idSträngObligatoriskt

Marknadsidentifierare returnerad av kontextendpointen.

request_idSträngObligatoriskt

Ärendets identifierare; i svarsmetadata identifierar detta HTTP-begäran.

minLength: 1maxLength: 100

PageMeta

Fullständig modell: PageMeta

paginationPagination Obligatoriskt

Metadata för markörbaserad paginering.

request_idSträngObligatoriskt

Ärendets identifierare; i svarsmetadata identifierar detta HTTP-begäran.

minLength: 1maxLength: 100

RequestMeta

Fullständig modell: RequestMeta

request_idSträngObligatoriskt

Ärendets identifierare; i svarsmetadata identifierar detta HTTP-begäran.

minLength: 1maxLength: 100
Exempel på svar

HTTP-status

200
Lyckat svar Schema
400
Ogiltig begäran
401
Autentisering krävs
403
Åtkomst nekad
404
Resursen hittades inte
409
Versionskonflikt
422
Valideringen misslyckades
429
Anropsgränsen överskreds
Övriga HTTP-statusar (7)
405
Metoden tillåts inte
413
För stor begäran
415
Formatet stöds inte
500
Serverfel
502
Fel i API-gateway
503
Tjänsten är inte tillgänglig
504
Tidsgränsen överskreds

Felkatalog: ErrorResponse

HTTP-huvuden

401

WWW-AuthenticateSträngValfritt

Autentiseringsschema som servern kräver.

405

AllowSträngValfritt

HTTP-metoder som resursen stöder.

429, 503

Retry-AfterHeltalValfritt

Minsta väntetid före ett nytt försök, i sekunder.

minimum: 0

Felkatalog · Läs mer