Popular

↑↓ move ↵ open All results →

Integration API · Orders

Get an order

GEThttps://{store}/api/v1/integrations/orders/{reference}

One placed order by its reference, in the same shape as the list: totals, lines, the buyer, delivery, payment and the buyer’s note.

Integration key with the orders:read ability: Authorization: Bearer {key}.

Path parameters

referencestringrequired
The order reference.

Responses

200The order. 
{
    "data": {
        "id": 1044,
        "reference": "2026-001044",
        "status": "payment-received",
        "total": 214000,
        "currency_code": "UAH",
        "placed_at": "2026-10-12 14:03:11",
        "updated_at": "2026-10-12 16:20:45",
        "customer": {
            "name": "Олена Коваль",
            "email": "[email protected]",
            "phone": "+380671234567",
            "first_name": "Олена",
            "last_name": "Коваль",
            "customer_id": 318
        },
        "subtotal": 214000,
        "shipping_total": 0,
        "discount_total": 0,
        "tax_total": 0,
        "lines": [
            {
                "id": 5012,
                "product_id": 12,
                "variant_id": 15,
                "sku": "SONAR-ANC-BLK",
                "name": "Навушники Sonar ANC повнорозмірні",
                "option": "Чорний · Гравіювання: Для Ані",
                "quantity": 1,
                "unit_price": 199000,
                "total": 199000
            },
            {
                "id": 5013,
                "product_id": 31,
                "variant_id": 40,
                "sku": "CASE-01",
                "name": "Чохол для навушників",
                "option": null,
                "quantity": 1,
                "unit_price": 15000,
                "total": 15000
            }
        ],
        "shipping": {
            "method": "Нова пошта",
            "carrier": "nova_poshta",
            "service_type": "branch",
            "city_name": "Київ",
            "city_ref": "8d5a980d-391c-11dd-90d9-001a92567626",
            "delivery_point_name": "Відділення №12",
            "delivery_point_ref": "1ec09d88-e1c2-11e3-8c4a-0050568002cf",
            "address": {
                "line_one": "Відділення №12",
                "line_two": null,
                "city": "Київ",
                "postcode": null,
                "country": "UA"
            },
            "method_code": "NOVA_POSHTA"
        },
        "payment": {
            "method": "app:com.storeforma.wayforpay"
        },
        "notes": "Подзвоніть перед відправкою"
    }
}
404No placed order with this reference. 
{
    "code": "not_found",
    "message": "not_found",
    "field": null
}
401Missing, unknown or revoked key. 
{
    "code": "unauthenticated",
    "message": "Integration key is inactive.",
    "field": null
}
403The key lacks orders:read, or the store’s plan has no API access. 
{
    "code": "forbidden",
    "message": "Integration key cannot orders:read.",
    "field": null
}
422A field is invalid; field names it. 
{
    "code": "validation_error",
    "message": "name is required.",
    "field": "name"
}
429More than 60 requests a minute for this key. Wait Retry-After seconds. 
{
    "code": "rate_limited",
    "message": "Too many integration requests.",
    "field": null
}