Aqbeż għall-kontenut
ShopentlyLearn
Malti

Ikseb — Ordnijiet

Aqra d-data minn “Ordnijiet”. Ir-riżultat jiddependi fuq il-parametri ta’ din l-operazzjoni.

GET/api/v1/orders/{order_id}

Awtentikazzjoni
Bearer
Disponibbli minn
BASIC
Permessi meħtieġa
orders.order:read

Eżempji ta’ kodiċi

Eżempju ta’ talba

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

Eżempju ta’ tweġiba 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"
  }
}

Kif jaħdem

  • Il-kollezzjoni tagħti sommarji tal-ordnijiet u filtri għan-numru, l-istatus, l-istatus tal-ħlas u l-ħin tal-ħolqien.
  • Il-lista u d-dettalji tal-ordnijiet jinkludu delivery.dates. Id-dati YYYY-MM-DD huma ppjanati u ma jikkonfermawx it-tluq. Id-dati attwali jieħdu preċedenza; ordnijiet qodma jużaw l-istima ssejvjata. Valuri mħassra jew mhux magħrufa huma null. Id-dettalji jinkludu wkoll il-linji kollha u l-immaġnijiet tal-prodotti.
  • Ikseb identifikaturi validi tal-istatus minn /api/v1/order-statuses.
  • L-istatus tal-ordni u tal-ħlas jużaw endpoints PATCH u permessi separati.
  • Il-bidla tal-istatus tal-ħlas irreġistrat ma tiġborx ħlas minn karta u ma tagħmilx rifużjoni permezz ta’ fornitur tal-ħlas.

Kitbiet siguri

Permessi u pjanijiet

Ordni · Totali

L-ammonti u r-rati jiġu mill-ordni maħżuna, inklużi l-korrezzjonijiet tal-linji. Id-dejta storika nieqsa hija null u ma tinbidilx bir-rati attwali tal-katalgu. L-ammonti jibqgħu strings deċimali.

Il-lista tagħti sommarji. Ikseb GET /api/v1/orders/{order_id} għal kull riżultat biex tesporta d-dettalji finanzjarji sħaħ. It-tentattivi GET huma limitati u jirrispettaw Retry-After. Esportazzjoni skont id-data tal-ħolqien ma tissinkronizzax korrezzjonijiet sussegwenti.

  • tax_country_code · Pajjiż tat-taxxa · Dejta maħżuna tal-ordni · ISO 3166-1 alpha-2; null.
  • lines[].unit_* · Unità waħda · Qabel l-iskontijiet; lines[].original_total_* · Qabel l-iskontijiet; lines[].total_* · Wara l-iskontijiet.
  • lines[].discount_* · Skontijiet; manual_discount · Skont manwali; percentage "10" = 10%.
  • delivery.net / tax / gross · Wara l-iskontijiet; delivery.original_* · Qabel l-iskontijiet; delivery.discount_* · Skontijiet.
  • tax_rate: "0.23" = 23%; "0" ≠ null. Mhux magħruf: null; żero magħruf: 0.
  • totals · Totali; tax_breakdown.groups · Gruppi tat-taxxa; Taxxa mhux allokata = order.tax − Σ groups.tax; ±.

payment.amount huwa t-total tal-ordni. L-istatus tal-ħlas ma jiddeterminax ammonti mħallsa, rimborżati jew dovuti.

Parametri

Parametri tal-mogħdija

order_idStringObbligatorju

Identifikatur tal-ordni relatata.

Restrizzjonijiet
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Eżempju: "example"

Din l-operazzjoni ma taċċettax kontenut JSON.

Tweġibiet

Risposta 200

Mudell sħiħ: ApiResponse_OrderDetailData_

dataOrderDetailData Obbligatorju

Data ta’ tweġiba ta’ suċċess.

Oqsma · data

Mudell sħiħ: OrderDetailData

created_atStringObbligatorju

Ħin tal-ħolqien.

format: "date-time"
customerCustomerData Obbligatorju

Informazzjoni tal-klijent irreġistrata għal din ir-riżorsa.

Oqsma · customer

Mudell sħiħ: CustomerData

emailStringObbligatorju

Indirizz tal-email.

first_nameString nullObbligatorju

Isem.

last_nameString nullObbligatorju

Kunjom.

phoneString nullObbligatorju

Numru tat-telefon.

deliveryShippingDetailData Obbligatorju

Metodu tal-kunsinna u informazzjoni assoċjata.

Oqsma · delivery

Mudell sħiħ: ShippingDetailData

amountMoneyData Obbligatorju

Ammont deċimali kkodifikat bħala string JSON; null biss fejn permess.

datesDeliveryDatesData Obbligatorju

Dati tat-tluq u tal-kunsinna

discount_grossMoneyData Obbligatorju

Ammont gross · Skontijiet; Mhux magħruf: null; żero magħruf: 0.

discount_netMoneyData nullObbligatorju

Ammont nett · Skontijiet; Mhux magħruf: null; żero magħruf: 0.

discount_taxMoneyData nullObbligatorju

Ammont tat-taxxa · Skontijiet; Mhux magħruf: null; żero magħruf: 0.

discountsArray <OrderDeliveryDiscountData > nullObbligatorju

Skontijiet

grossMoneyData Obbligatorju

Ammont gross · Wara l-iskontijiet; Mhux magħruf: null; żero magħruf: 0.

method_codeString nullObbligatorju

Kodiċi tal-metodu tal-kunsinna jew tal-ħlas.

method_nameString nullObbligatorju

Isem tal-metodu tal-kunsinna jew tal-ħlas.

netMoneyData nullObbligatorju

Ammont nett · Wara l-iskontijiet; Mhux magħruf: null; żero magħruf: 0.

original_grossMoneyData Obbligatorju

Ammont gross · Kunsinna · Qabel l-iskontijiet; Mhux magħruf: null; żero magħruf: 0.

original_netMoneyData nullObbligatorju

Ammont nett · Kunsinna · Qabel l-iskontijiet; Mhux magħruf: null; żero magħruf: 0.

original_taxMoneyData nullObbligatorju

Ammont tat-taxxa · Kunsinna · Qabel l-iskontijiet; Mhux magħruf: null; żero magħruf: 0.

pickup_pointDeliveryPickupPointData nullObbligatorju

Punt tal-ġbir

recipient_modeStringObbligatorju

Varjant tal-istruttura tad-data deskritt mill-valuri permessi tiegħu.

Restrizzjonijiet
enum
["full_address", "pickup_contact"]
taxMoneyData nullObbligatorju

Informazzjoni tat-taxxa.

tax_category_idString nullObbligatorju

Identifikatur tal-kategorija tat-taxxa.

tax_category_nameString nullObbligatorju

Isem maħżun tal-kategorija tat-taxxa; null.

tax_rateString nullObbligatorju

tax_rate · Dejta maħżuna tal-ordni: "0.23" = 23%; "0" ≠ null.

discount_amountMoneyData Obbligatorju

Ammont deċimali kkodifikat bħala string JSON; null biss fejn permess.

Oqsma · discount_amount

Mudell sħiħ: MoneyData

amountStringObbligatorju

Ammont deċimali kkodifikat bħala string JSON; null biss fejn permess.

currencyStringObbligatorju

Kodiċi tal-munita tal-ammont.

Restrizzjonijiet
pattern
"^[A-Z]{3}$"
minor_unitsNumru sħiħObbligatorju

Numru ta’ ċifri deċimali użati mill-munita.

minimum: 0maximum: 4
discountsArray <OrderDiscountData > Obbligatorju

Skontijiet

Oqsma · discounts

OrderDiscountData

Mudell sħiħ: OrderDiscountData

idStringObbligatorju

Identifikatur tar-riżorsa; żommu kif mogħti.

invoiceInvoiceData nullObbligatorju

Informazzjoni tal-fattura.

Oqsma · invoice

InvoiceData

Mudell sħiħ: InvoiceData

null

invoice_requestedBooleanObbligatorju

Jekk intalbitx fattura.

lifecycle_stateOrderLifecycleState Obbligatorju

Stat taċ-ċiklu tal-ħajja tan-negozju.

linesArray <OrderLineData > Obbligatorju

Kopji tal-linji tal-ordni kif kienu fil-mument tal-ordni.

Oqsma · lines

OrderLineData

Mudell sħiħ: OrderLineData

localeStringObbligatorju

Lingwa magħżula għal din it-talba.

market_idStringObbligatorju

Identifikatur tas-suq mogħti mill-endpoint tal-kuntest.

numberStringObbligatorju

Numru tal-ordni jew tat-talba muri lill-bniedem.

paymentPaymentData Obbligatorju

Dettalji tal-ħlas irreġistrati għall-ordni.

Oqsma · payment

Mudell sħiħ: PaymentData

amountMoneyData Obbligatorju

Ammont deċimali kkodifikat bħala string JSON; null biss fejn permess.

environmentStringObbligatorju

Informazzjoni tal-ambjent mehmuża mar-rekord.

Restrizzjonijiet
enum
["live", "sandbox"]
method_codeString nullObbligatorju

Kodiċi tal-metodu tal-kunsinna jew tal-ħlas.

method_nameString nullObbligatorju

Isem tal-metodu tal-kunsinna jew tal-ħlas.

paid_atString nullObbligatorju

Data u ħin meta l-ħlas ġie mmarkat bħala mħallas.

String:format: "date-time"
statusOrderPaymentStatus Obbligatorju

Status aċċettat minn din l-operazzjoni speċifika.

updated_atStringObbligatorju

Ħin tal-aktar aġġornament reċenti.

format: "date-time"
versionNumru sħiħObbligatorju

Verżjoni tar-riżorsa għall-kontroll tal-konkorrenza.

pickup_pointPickupPointData nullObbligatorju

Punt tal-ġbir

Oqsma · pickup_point

PickupPointData

Mudell sħiħ: PickupPointData

null

prices_include_taxBooleanObbligatorju

Jekk il-prezzijiet elenkati jinkludux it-taxxa.

shipping_addressAddressData nullObbligatorju

Indirizz tal-kunsinna.

Oqsma · shipping_address

AddressData

Mudell sħiħ: AddressData

null

shipping_discount_amountMoneyData Obbligatorju

Ammont deċimali kkodifikat bħala string JSON; null biss fejn permess.

Oqsma · shipping_discount_amount

Mudell sħiħ: MoneyData

amountStringObbligatorju

Ammont deċimali kkodifikat bħala string JSON; null biss fejn permess.

currencyStringObbligatorju

Kodiċi tal-munita tal-ammont.

Restrizzjonijiet
pattern
"^[A-Z]{3}$"
minor_unitsNumru sħiħObbligatorju

Numru ta’ ċifri deċimali użati mill-munita.

minimum: 0maximum: 4
statusOrderStatusData Obbligatorju

Status aċċettat minn din l-operazzjoni speċifika.

Oqsma · status

Mudell sħiħ: OrderStatusData

idStringObbligatorju

Identifikatur tar-riżorsa; żommu kif mogħti.

nameStringObbligatorju

Isem tar-riżorsa fil-kuntest rilevanti.

updated_atStringObbligatorju

Ħin tal-aktar aġġornament reċenti.

format: "date-time"
versionNumru sħiħObbligatorju

Verżjoni tar-riżorsa għall-kontroll tal-konkorrenza.

subtotalMoneyData Obbligatorju

Ammont qabel il-komponenti addizzjonali murija fit-tweġiba.

Oqsma · subtotal

Mudell sħiħ: MoneyData

amountStringObbligatorju

Ammont deċimali kkodifikat bħala string JSON; null biss fejn permess.

currencyStringObbligatorju

Kodiċi tal-munita tal-ammont.

Restrizzjonijiet
pattern
"^[A-Z]{3}$"
minor_unitsNumru sħiħObbligatorju

Numru ta’ ċifri deċimali użati mill-munita.

minimum: 0maximum: 4
taxMoneyData Obbligatorju

Informazzjoni tat-taxxa.

Oqsma · tax

Mudell sħiħ: MoneyData

amountStringObbligatorju

Ammont deċimali kkodifikat bħala string JSON; null biss fejn permess.

currencyStringObbligatorju

Kodiċi tal-munita tal-ammont.

Restrizzjonijiet
pattern
"^[A-Z]{3}$"
minor_unitsNumru sħiħObbligatorju

Numru ta’ ċifri deċimali użati mill-munita.

minimum: 0maximum: 4
tax_breakdownOrderTaxBreakdownData Obbligatorju

Gruppi tat-taxxa · source + tax_rate; unallocated_tax.

Oqsma · tax_breakdown

Mudell sħiħ: OrderTaxBreakdownData

groupsArray <OrderTaxGroupData > Obbligatorju

Gruppi tat-taxxa · source + tax_rate; Mhux magħruf: null; żero magħruf: 0.

unallocated_taxMoneyData Obbligatorju

Taxxa mhux allokata = order.tax − Σ groups.tax; ±.

tax_country_codeString nullObbligatorju

Pajjiż tat-taxxa · Dejta maħżuna tal-ordni · ISO 3166-1 alpha-2; null.

totalMoneyData Obbligatorju

Ammont totali.

Oqsma · total

Mudell sħiħ: MoneyData

amountStringObbligatorju

Ammont deċimali kkodifikat bħala string JSON; null biss fejn permess.

currencyStringObbligatorju

Kodiċi tal-munita tal-ammont.

Restrizzjonijiet
pattern
"^[A-Z]{3}$"
minor_unitsNumru sħiħObbligatorju

Numru ta’ ċifri deċimali użati mill-munita.

minimum: 0maximum: 4
totalsOrderTotalsData Obbligatorju

Totali · net / tax / gross; Qabel l-iskontijiet / Wara l-iskontijiet.

Oqsma · totals

Mudell sħiħ: OrderTotalsData

before_discountsOrderAmountBreakdownData Obbligatorju

Ordni · Qabel l-iskontijiet · net / tax / gross.

discountsOrderAmountBreakdownData Obbligatorju

Skontijiet

orderOrderAmountBreakdownData Obbligatorju

Ordni · Wara l-iskontijiet · net / tax / gross.

product_discountsOrderAmountBreakdownData Obbligatorju

Prodotti · Skontijiet · net / tax / gross.

productsOrderAmountBreakdownData Obbligatorju

Prodotti · Wara l-iskontijiet · net / tax / gross.

products_before_discountsOrderAmountBreakdownData Obbligatorju

Prodotti · Qabel l-iskontijiet · net / tax / gross.

shippingOrderAmountBreakdownData Obbligatorju

Kunsinna · Wara l-iskontijiet · net / tax / gross.

shipping_before_discountsOrderAmountBreakdownData Obbligatorju

Kunsinna · Qabel l-iskontijiet · net / tax / gross.

shipping_discountsOrderAmountBreakdownData Obbligatorju

Kunsinna · Skontijiet · net / tax / gross.

metaContextPageMeta ContextMeta PageMeta RequestMeta Obbligatorju

Metadata tat-tweġiba.

Oqsma · meta

ContextPageMeta

Mudell sħiħ: ContextPageMeta

localeStringObbligatorju

Lingwa magħżula għal din it-talba.

market_codeStringObbligatorju

Kodiċi tas-suq mogħti mill-endpoint tal-kuntest.

market_idStringObbligatorju

Identifikatur tas-suq mogħti mill-endpoint tal-kuntest.

paginationPagination Obbligatorju

Metadata tal-paġinazzjoni bil-cursor.

request_idStringObbligatorju

Identifikatur tat-talba; fil-metadata tat-tweġiba jidentifika t-talba HTTP.

minLength: 1maxLength: 100

ContextMeta

Mudell sħiħ: ContextMeta

localeStringObbligatorju

Lingwa magħżula għal din it-talba.

market_codeStringObbligatorju

Kodiċi tas-suq mogħti mill-endpoint tal-kuntest.

market_idStringObbligatorju

Identifikatur tas-suq mogħti mill-endpoint tal-kuntest.

request_idStringObbligatorju

Identifikatur tat-talba; fil-metadata tat-tweġiba jidentifika t-talba HTTP.

minLength: 1maxLength: 100

PageMeta

Mudell sħiħ: PageMeta

paginationPagination Obbligatorju

Metadata tal-paġinazzjoni bil-cursor.

request_idStringObbligatorju

Identifikatur tat-talba; fil-metadata tat-tweġiba jidentifika t-talba HTTP.

minLength: 1maxLength: 100

RequestMeta

Mudell sħiħ: RequestMeta

request_idStringObbligatorju

Identifikatur tat-talba; fil-metadata tat-tweġiba jidentifika t-talba HTTP.

minLength: 1maxLength: 100
Eżempju ta’ tweġiba

Status HTTP

200
Risposta b’suċċess Skema
400
Talba mhux valida
401
Awtentikazzjoni meħtieġa
403
Permess miċħud
404
Riżorsa ma nstabitx
409
Kunflitt tal-verżjoni
422
Validazzjoni falliet
429
Inqabeż il-limitu tat-talbiet
Stati HTTP oħra (7)
405
Metodu mhux permess
413
Talba kbira wisq
415
Format mhux appoġġjat
500
Żball tas-server
502
Żball tal-gateway tal-API
503
Servizz mhux disponibbli
504
Skada l-ħin ta’ stennija

Katalgu tal-iżbalji: ErrorResponse

Headers

401

WWW-AuthenticateStringMhux obbligatorju

Skema ta’ awtentikazzjoni meħtieġa mis-server.

405

AllowStringMhux obbligatorju

Metodi HTTP appoġġati minn din ir-riżorsa.

429, 503

Retry-AfterNumru sħiħMhux obbligatorju

Dewmien minimu qabel tentattiv ieħor, f’sekondi.

minimum: 0

Katalgu tal-iżbalji · Aktar tagħrif