Retrieve order

cURL

curl --request GET --fail-with-body --max-time 30 \
  "${AMLOK_API_BASE_URL}/v1/orders/order_example?fields=id%2Cobject%2Cupdated_at&include=provenance" \
  --header "Authorization: Bearer ${AMLOK_API_KEY}" \
  --header "Accept: application/json"

import os
import requests

base_url = os.environ["AMLOK_API_BASE_URL"].rstrip("/")
headers = {'Accept': 'application/json'}
headers["Authorization"] = "Bearer " + os.environ["AMLOK_API_KEY"]

response = requests.request(
    "GET", base_url + "/v1/orders/order_example?fields=id%2Cobject%2Cupdated_at&include=provenance",
    headers=headers, timeout=30, allow_redirects=False,
)
response.raise_for_status()
print(response.json())

const baseUrl = process.env.AMLOK_API_BASE_URL;
const apiKey = process.env.AMLOK_API_KEY;
if (!baseUrl || !apiKey) throw new Error("Configure AMLOK_API_BASE_URL and AMLOK_API_KEY");
const headers = {
  "Accept": "application/json"
};
headers.Authorization = `Bearer ${apiKey}`;
const response = await fetch(baseUrl.replace(/\/$/, "") + "/v1/orders/order_example?fields=id%2Cobject%2Cupdated_at&include=provenance", {
  method: "GET", headers,
  redirect: "error", signal: AbortSignal.timeout(30000),
});
if (!response.ok) throw new Error(`AMLOK returned HTTP ${response.status}`);
console.log(await response.json());

{
  "data": {
    "id": "order_example",
    "object": "order",
    "subject_id": "biz_example",
    "created_at": "2026-10-23T14:00:00Z",
    "updated_at": "2026-10-23T14:00:00Z",
    "record_version": 1,
    "source_refs": [],
    "data_status": "partial",
    "missing_fields": [],
    "schema_version": "1.4.2",
    "client_reference": "app-1029",
    "order_number": "ORD-1001",
    "source_order_id": "gid://example/Order/1001",
    "customer_id": "pty_example",
    "location_id": "loc_example",
    "channel": "online",
    "status": "completed",
    "payment_status": "paid",
    "fulfillment_status": "fulfilled",
    "placed_at": null,
    "cancelled_at": null,
    "subtotal": {
      "amount": "1234.56",
      "currency": "CAD"
    },
    "discount_total": {
      "amount": "1234.56",
      "currency": "CAD"
    },
    "tax_total": {
      "amount": "1234.56",
      "currency": "CAD"
    },
    "shipping_total": {
      "amount": "1234.56",
      "currency": "CAD"
    },
    "total": {
      "amount": "1234.56",
      "currency": "CAD"
    },
    "current_total": {
      "amount": "1234.56",
      "currency": "CAD"
    },
    "refunded_total": {
      "amount": "1234.56",
      "currency": "CAD"
    },
    "presentment_currency": "USD",
    "taxes_included": false,
    "is_test": false,
    "line_ids": [
      "oli_example"
    ]
  },
  "meta": {
    "request_id": "req_example",
    "schema_version": "1.4.2",
    "generated_at": "2026-10-23T14:00:00Z",
    "data_status": "partial"
  }
}

GET

orders

{id}

cURL

curl --request GET --fail-with-body --max-time 30 \
  "${AMLOK_API_BASE_URL}/v1/orders/order_example?fields=id%2Cobject%2Cupdated_at&include=provenance" \
  --header "Authorization: Bearer ${AMLOK_API_KEY}" \
  --header "Accept: application/json"

import os
import requests

base_url = os.environ["AMLOK_API_BASE_URL"].rstrip("/")
headers = {'Accept': 'application/json'}
headers["Authorization"] = "Bearer " + os.environ["AMLOK_API_KEY"]

response = requests.request(
    "GET", base_url + "/v1/orders/order_example?fields=id%2Cobject%2Cupdated_at&include=provenance",
    headers=headers, timeout=30, allow_redirects=False,
)
response.raise_for_status()
print(response.json())

const baseUrl = process.env.AMLOK_API_BASE_URL;
const apiKey = process.env.AMLOK_API_KEY;
if (!baseUrl || !apiKey) throw new Error("Configure AMLOK_API_BASE_URL and AMLOK_API_KEY");
const headers = {
  "Accept": "application/json"
};
headers.Authorization = `Bearer ${apiKey}`;
const response = await fetch(baseUrl.replace(/\/$/, "") + "/v1/orders/order_example?fields=id%2Cobject%2Cupdated_at&include=provenance", {
  method: "GET", headers,
  redirect: "error", signal: AbortSignal.timeout(30000),
});
if (!response.ok) throw new Error(`AMLOK returned HTTP ${response.status}`);
console.log(await response.json());

{
  "data": {
    "id": "order_example",
    "object": "order",
    "subject_id": "biz_example",
    "created_at": "2026-10-23T14:00:00Z",
    "updated_at": "2026-10-23T14:00:00Z",
    "record_version": 1,
    "source_refs": [],
    "data_status": "partial",
    "missing_fields": [],
    "schema_version": "1.4.2",
    "client_reference": "app-1029",
    "order_number": "ORD-1001",
    "source_order_id": "gid://example/Order/1001",
    "customer_id": "pty_example",
    "location_id": "loc_example",
    "channel": "online",
    "status": "completed",
    "payment_status": "paid",
    "fulfillment_status": "fulfilled",
    "placed_at": null,
    "cancelled_at": null,
    "subtotal": {
      "amount": "1234.56",
      "currency": "CAD"
    },
    "discount_total": {
      "amount": "1234.56",
      "currency": "CAD"
    },
    "tax_total": {
      "amount": "1234.56",
      "currency": "CAD"
    },
    "shipping_total": {
      "amount": "1234.56",
      "currency": "CAD"
    },
    "total": {
      "amount": "1234.56",
      "currency": "CAD"
    },
    "current_total": {
      "amount": "1234.56",
      "currency": "CAD"
    },
    "refunded_total": {
      "amount": "1234.56",
      "currency": "CAD"
    },
    "presentment_currency": "USD",
    "taxes_included": false,
    "is_test": false,
    "line_ids": [
      "oli_example"
    ]
  },
  "meta": {
    "request_id": "req_example",
    "schema_version": "1.4.2",
    "generated_at": "2026-10-23T14:00:00Z",
    "data_status": "partial"
  }
}

Required scope: commerce:read Retrieve one order with provenance. Required scope: commerce:read. Tenant and field entitlements enforced; unknown or invisible ID returns 404. Product scope · Processing lifecycle · Errors

Authorizations

Authorization

string

header

required

Server-to-server API key bound to exactly one workspace, institution tenant and environment. No caller-supplied workspace override is accepted. Do not use in public browser code.

Headers

X-Request-ID

string

Optional caller correlation ID; the response includes AMLOK request_id.

Path Parameters

string

required

Tenant-visible resource identifier.

Query Parameters

fields

string

Comma-separated top-level field names. Required identity and metadata always remain. Selected objects are complete; nested paths and wildcards are unsupported. Unknown fields return 400 validation_error.

include

string

Comma-separated optional expansions: provenance, missing_fields. No unrestricted graph traversal.

manifest_id

string

Optional immutable input-manifest ID. Return the exact normalized resource version listed in that manifest, not the current version. Reject IDs absent from the manifest or another subject/workspace.

Response

Retrieve one order with provenance.

data

OrderRead · object

required

Commercial sale order with amounts distinct from payment and accounting revenue. Population depends on source and tenant entitlement. Read representation: fields selects top-level domain fields. Required metadata is always returned. Selected nested objects retain their complete schema. Without fields, return the full authorized representation.

Show child attributes

Get started

Endpoints

Essentials

Retrieve order

Authorizations

Headers

Path Parameters

Query Parameters

Response