Faigh — Orduithe

Léigh sonraí ó “Orduithe”. Braitheann an toradh ar pharaiméadair na hoibríochta seo.

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

Fíordheimhniú: Bearer
Ar fáil ó: BASIC
Ceadanna riachtanacha: orders.order:read

Sampla iarratais

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

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

Conas a oibríonn sé

Soláthraíonn an bailiúchán achoimrí agus scagairí de réir uimhir, stádais, stádais íocaíochta agus am cruthaithe.
Tá delivery.dates ar fáil sa liosta orduithe agus sna sonraí. Is dátaí pleanáilte iad YYYY-MM-DD agus ní dheimhníonn siad seoladh. Tá tosaíocht ag na dátaí reatha; úsáideann seanorduithe an meastachán sábháilte. Is null iad luachanna glanta nó anaithnide. Tá gach líne ordaithe agus íomhá táirge sna sonraí freisin.

Faigh aitheantóirí bailí stádais ó /api/v1/order-statuses.
Tá críochphointí PATCH agus ceadanna ar leith ag stádas ordaithe agus stádas íocaíochta.
Ní ghearrann athrú ar an stádas íocaíochta taifeadta cárta agus ní eisíonn sé aisíocaíocht trí sholáthraí íocaíochta.

Scríobh sábháilte

Ceadanna agus pleananna

Ordú · Iomláin

Tagann na méideanna agus rátaí cánach ón ordú sábháilte, lena n-áirítear ceartúcháin línte. Is null iad sonraí stairiúla atá ar iarraidh agus ní chuirtear rátaí reatha an chatalóige ina n-áit. Fanann méideanna mar theaghráin dheachúlacha.

Tugann an liosta achoimrí. Faigh GET /api/v1/orders/{order_id} do gach toradh chun na sonraí airgeadais iomlána a easpórtáil. Tá teorainn le hathiarrachtaí GET agus cloíonn siad le Retry-After. Ní shioncronaíonn easpórtáil de réir dáta cruthaithe ceartúcháin níos déanaí.

tax_country_code · Tír chánach · Sonraí sábháilte an ordaithe · ISO 3166-1 alpha-2; null.
lines[].unit_* · Aonad amháin · Roimh lascainí; lines[].original_total_* · Roimh lascainí; lines[].total_* · Tar éis lascainí.
lines[].discount_* · Lascainí; manual_discount · Lascaine láimhe; percentage "10" = 10%.
delivery.net / tax / gross · Tar éis lascainí; delivery.original_* · Roimh lascainí; delivery.discount_* · Lascainí.
tax_rate: "0.23" = 23%; "0" ≠ null. Anaithnid: null; náid aitheanta: 0.
totals · Iomláin; tax_breakdown.groups · Grúpaí cánach; Cáin neamh-leithdháilte = order.tax − Σ groups.tax; ±.

Is é payment.amount iomlán an ordaithe. Ní chinneann stádas íocaíochta méideanna íoctha, aisíoctha ná dlite.

Paraiméadair

Paraiméadair chosáin

order_idTeaghránRiachtanach

Aitheantóir ordaithe ghaolmhair.

Srianta

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

Sampla: "example"

Ní ghlacann an oibríocht seo le corp JSON.

Freagraí

Freagra 200

Samhail iomlán: ApiResponse_OrderDetailData_

dataOrderDetailData Riachtanach

Sonraí freagra rathúil.

Réimsí · data

Samhail iomlán: OrderDetailData

created_atTeaghránRiachtanach

Am cruthaithe.

format: "date-time"

customerCustomerData Riachtanach

Eolas custaiméara taifeadta don acmhainn seo.

Réimsí · customer

Samhail iomlán: CustomerData

emailTeaghránRiachtanach: Seoladh ríomhphoist.
first_nameTeaghrán nullRiachtanach: Céadainm.
last_nameTeaghrán nullRiachtanach: Sloinne.
phoneTeaghrán nullRiachtanach: Uimhir theileafóin.

deliveryShippingDetailData Riachtanach

Modh seachadta agus eolas gaolmhar.

Réimsí · delivery

Samhail iomlán: ShippingDetailData

amountMoneyData Riachtanach

Suim dheachúlach mar theaghrán JSON; null ach amháin nuair a cheadaítear é.

datesDeliveryDatesData Riachtanach

Dátaí seolta agus seachadta

discount_grossMoneyData Riachtanach

Ollmhéid · Lascainí; Anaithnid: null; náid aitheanta: 0.

discount_netMoneyData nullRiachtanach

Glanmhéid · Lascainí; Anaithnid: null; náid aitheanta: 0.

discount_taxMoneyData nullRiachtanach

Méid cánach · Lascainí; Anaithnid: null; náid aitheanta: 0.

discountsEagar <OrderDeliveryDiscountData > nullRiachtanach

Lascainí

grossMoneyData Riachtanach

Ollmhéid · Tar éis lascainí; Anaithnid: null; náid aitheanta: 0.

method_codeTeaghrán nullRiachtanach

Cód modha seachadta nó íocaíochta.

method_nameTeaghrán nullRiachtanach

Ainm modha seachadta nó íocaíochta.

netMoneyData nullRiachtanach

Glanmhéid · Tar éis lascainí; Anaithnid: null; náid aitheanta: 0.

original_grossMoneyData Riachtanach

Ollmhéid · Seachadadh · Roimh lascainí; Anaithnid: null; náid aitheanta: 0.

original_netMoneyData nullRiachtanach

Glanmhéid · Seachadadh · Roimh lascainí; Anaithnid: null; náid aitheanta: 0.

original_taxMoneyData nullRiachtanach

Méid cánach · Seachadadh · Roimh lascainí; Anaithnid: null; náid aitheanta: 0.

pickup_pointDeliveryPickupPointData nullRiachtanach

Pointe bailithe

recipient_modeTeaghránRiachtanach

Leagan den struchtúr sonraí a shainíonn na luachanna ceadaithe.

Srianta

enum: ["full_address", "pickup_contact"]

taxMoneyData nullRiachtanach

Eolas cánach.

tax_category_idTeaghrán nullRiachtanach

Aitheantóir catagóire cánach.

tax_category_nameTeaghrán nullRiachtanach

Ainm sábháilte na catagóire cánach; null.

tax_rateTeaghrán nullRiachtanach

tax_rate · Sonraí sábháilte an ordaithe: "0.23" = 23%; "0" ≠ null.

discount_amountMoneyData Riachtanach

Suim dheachúlach mar theaghrán JSON; null ach amháin nuair a cheadaítear é.

Réimsí · discount_amount

Samhail iomlán: MoneyData

amountTeaghránRiachtanach

Suim dheachúlach mar theaghrán JSON; null ach amháin nuair a cheadaítear é.

currencyTeaghránRiachtanach

Cód airgeadra na suime.

Srianta

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

minor_unitsSlánuimhirRiachtanach

Líon na n-ionad deachúlach a úsáideann an t-airgeadra.

minimum: 0maximum: 4

discountsEagar <OrderDiscountData > Riachtanach

Lascainí

Réimsí · discounts

OrderDiscountData

Samhail iomlán: OrderDiscountData

idTeaghránRiachtanach

Aitheantóir acmhainne; coinnigh mar a tugadh ar ais é.

invoiceInvoiceData nullRiachtanach

Eolas sonraisc.

Réimsí · invoice

InvoiceData

Samhail iomlán: InvoiceData

null

invoice_requestedLuach BooleRiachtanach

Ar iarradh sonrasc.

lifecycle_stateOrderLifecycleState Riachtanach

Staid shaolré ghnó.

linesEagar <OrderLineData > Riachtanach

Cóipeanna de shonraí línte ordaithe tráth an ordaithe.

Réimsí · lines

OrderLineData

Samhail iomlán: OrderLineData

localeTeaghránRiachtanach

Teanga roghnaithe don iarratas seo.

market_idTeaghránRiachtanach

Aitheantóir margaidh a thugann an críochphointe comhthéacs.

numberTeaghránRiachtanach

Uimhir ordaithe nó iarratais atá le léamh ag duine.

paymentPaymentData Riachtanach

Sonraí íocaíochta taifeadta don ordú.

Réimsí · payment

Samhail iomlán: PaymentData

amountMoneyData Riachtanach

Suim dheachúlach mar theaghrán JSON; null ach amháin nuair a cheadaítear é.

environmentTeaghránRiachtanach

Eolas timpeallachta a ghabhann leis an taifead.

Srianta

enum: ["live", "sandbox"]

method_codeTeaghrán nullRiachtanach

Cód modha seachadta nó íocaíochta.

method_nameTeaghrán nullRiachtanach

Ainm modha seachadta nó íocaíochta.

paid_atTeaghrán nullRiachtanach

Dáta agus am a marcáladh an íocaíocht íoctha.

Teaghrán:format: "date-time"

statusOrderPaymentStatus Riachtanach

Stádas a ghlacann an oibríocht áirithe seo.

updated_atTeaghránRiachtanach

Am an nuashonraithe is déanaí.

format: "date-time"

versionSlánuimhirRiachtanach

Leagan acmhainne a úsáidtear le haghaidh rialú comhreatha.

pickup_pointPickupPointData nullRiachtanach

Pointe bailithe

Réimsí · pickup_point

PickupPointData

Samhail iomlán: PickupPointData

null

prices_include_taxLuach BooleRiachtanach

An bhfuil cáin sna praghsanna liostaithe.

shipping_addressAddressData nullRiachtanach

Seoladh seachadta.

Réimsí · shipping_address

AddressData

Samhail iomlán: AddressData

null

shipping_discount_amountMoneyData Riachtanach

Suim dheachúlach mar theaghrán JSON; null ach amháin nuair a cheadaítear é.

Réimsí · shipping_discount_amount

Samhail iomlán: MoneyData

amountTeaghránRiachtanach

Suim dheachúlach mar theaghrán JSON; null ach amháin nuair a cheadaítear é.

currencyTeaghránRiachtanach

Cód airgeadra na suime.

Srianta

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

minor_unitsSlánuimhirRiachtanach

Líon na n-ionad deachúlach a úsáideann an t-airgeadra.

minimum: 0maximum: 4

statusOrderStatusData Riachtanach

Stádas a ghlacann an oibríocht áirithe seo.

Réimsí · status

Samhail iomlán: OrderStatusData

idTeaghránRiachtanach: Aitheantóir acmhainne; coinnigh mar a tugadh ar ais é.
nameTeaghránRiachtanach: Ainm acmhainne sa chomhthéacs cuí.
updated_atTeaghránRiachtanach: Am an nuashonraithe is déanaí.
format: "date-time"
versionSlánuimhirRiachtanach: Leagan acmhainne a úsáidtear le haghaidh rialú comhreatha.

subtotalMoneyData Riachtanach

Suim roimh na comhpháirteanna breise a thaispeántar sa fhreagra.

Réimsí · subtotal

Samhail iomlán: MoneyData

amountTeaghránRiachtanach

Suim dheachúlach mar theaghrán JSON; null ach amháin nuair a cheadaítear é.

currencyTeaghránRiachtanach

Cód airgeadra na suime.

Srianta

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

minor_unitsSlánuimhirRiachtanach

Líon na n-ionad deachúlach a úsáideann an t-airgeadra.

minimum: 0maximum: 4

taxMoneyData Riachtanach

Eolas cánach.

Réimsí · tax

Samhail iomlán: MoneyData

amountTeaghránRiachtanach

Suim dheachúlach mar theaghrán JSON; null ach amháin nuair a cheadaítear é.

currencyTeaghránRiachtanach

Cód airgeadra na suime.

Srianta

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

minor_unitsSlánuimhirRiachtanach

Líon na n-ionad deachúlach a úsáideann an t-airgeadra.

minimum: 0maximum: 4

tax_breakdownOrderTaxBreakdownData Riachtanach

Grúpaí cánach · source + tax_rate; unallocated_tax.

Réimsí · tax_breakdown

Samhail iomlán: OrderTaxBreakdownData

groupsEagar <OrderTaxGroupData > Riachtanach: Grúpaí cánach · source + tax_rate; Anaithnid: null; náid aitheanta: 0.
unallocated_taxMoneyData Riachtanach: Cáin neamh-leithdháilte = order.tax − Σ groups.tax; ±.

tax_country_codeTeaghrán nullRiachtanach

Tír chánach · Sonraí sábháilte an ordaithe · ISO 3166-1 alpha-2; null.

totalMoneyData Riachtanach

Suim iomlán.

Réimsí · total

Samhail iomlán: MoneyData

amountTeaghránRiachtanach

Suim dheachúlach mar theaghrán JSON; null ach amháin nuair a cheadaítear é.

currencyTeaghránRiachtanach

Cód airgeadra na suime.

Srianta

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

minor_unitsSlánuimhirRiachtanach

Líon na n-ionad deachúlach a úsáideann an t-airgeadra.

minimum: 0maximum: 4

totalsOrderTotalsData Riachtanach

Iomláin · net / tax / gross; Roimh lascainí / Tar éis lascainí.

Réimsí · totals

Samhail iomlán: OrderTotalsData

before_discountsOrderAmountBreakdownData Riachtanach: Ordú · Roimh lascainí · net / tax / gross.
discountsOrderAmountBreakdownData Riachtanach: Lascainí
orderOrderAmountBreakdownData Riachtanach: Ordú · Tar éis lascainí · net / tax / gross.
product_discountsOrderAmountBreakdownData Riachtanach: Táirgí · Lascainí · net / tax / gross.
productsOrderAmountBreakdownData Riachtanach: Táirgí · Tar éis lascainí · net / tax / gross.
products_before_discountsOrderAmountBreakdownData Riachtanach: Táirgí · Roimh lascainí · net / tax / gross.
shippingOrderAmountBreakdownData Riachtanach: Seachadadh · Tar éis lascainí · net / tax / gross.
shipping_before_discountsOrderAmountBreakdownData Riachtanach: Seachadadh · Roimh lascainí · net / tax / gross.
shipping_discountsOrderAmountBreakdownData Riachtanach: Seachadadh · Lascainí · net / tax / gross.

metaContextPageMeta ContextMeta PageMeta RequestMeta Riachtanach

Meiteashonraí an fhreagra.

Réimsí · meta

ContextPageMeta

Samhail iomlán: ContextPageMeta

localeTeaghránRiachtanach: Teanga roghnaithe don iarratas seo.
market_codeTeaghránRiachtanach: Cód margaidh a thugann an críochphointe comhthéacs.
market_idTeaghránRiachtanach: Aitheantóir margaidh a thugann an críochphointe comhthéacs.
paginationPagination Riachtanach: Meiteashonraí leathanaithe le cúrsóir.
request_idTeaghránRiachtanach: Aitheantóir iarratais; i meiteashonraí freagra aithníonn sé an t-iarratas HTTP.
minLength: 1maxLength: 100

ContextMeta

Samhail iomlán: ContextMeta

localeTeaghránRiachtanach: Teanga roghnaithe don iarratas seo.
market_codeTeaghránRiachtanach: Cód margaidh a thugann an críochphointe comhthéacs.
market_idTeaghránRiachtanach: Aitheantóir margaidh a thugann an críochphointe comhthéacs.
request_idTeaghránRiachtanach: Aitheantóir iarratais; i meiteashonraí freagra aithníonn sé an t-iarratas HTTP.
minLength: 1maxLength: 100

PageMeta

Samhail iomlán: PageMeta

paginationPagination Riachtanach: Meiteashonraí leathanaithe le cúrsóir.
request_idTeaghránRiachtanach: Aitheantóir iarratais; i meiteashonraí freagra aithníonn sé an t-iarratas HTTP.
minLength: 1maxLength: 100

RequestMeta

Samhail iomlán: RequestMeta

request_idTeaghránRiachtanach: Aitheantóir iarratais; i meiteashonraí freagra aithníonn sé an t-iarratas HTTP.
minLength: 1maxLength: 100

Sampla freagra

Stádas HTTP

200: Freagra rathúil Scéim
400: Iarratas neamhbhailí
401: Fíordheimhniú riachtanach
403: Cead diúltaithe
404: Acmhainn gan aimsiú
409: Coinbhleacht leagain
422: Theip ar bhailíochtú
429: Teorainn iarratas sáraithe

Stádais HTTP eile (7)

405: Modh neamhcheadaithe
413: Iarratas rómhór
415: Formáid gan tacaíocht
500: Earráid freastalaí
502: Earráid gheata API
503: Seirbhís gan fáil
504: Teorainn ama sáraithe

Catalóg earráidí: ErrorResponse

Ceanntásca

401

WWW-AuthenticateTeaghránRoghnach: An scéim fíordheimhnithe a éilíonn an freastalaí.

405

AllowTeaghránRoghnach: Modhanna HTTP a thacaíonn an acmhainn seo leo.

429, 503

Retry-AfterSlánuimhirRoghnach: An mhoill íosta roimh atriail, i soicindí.

minimum: 0

Catalóg earráidí · Tuilleadh eolais

GET/api/v1/orders/{order_id}

Samplaí cóid

Sampla iarratais

cURL

PHP

Python

Sampla freagra 200

Conas a oibríonn sé

Ordú · Iomláin

Paraiméadair

Paraiméadair chosáin

Freagraí

Freagra 200

Stádas HTTP

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