Ana içeriğe geç

Sipariş listesi

Panelde / entegrasyonla oluşan sipariş kayıtlarını listelemek için bu endpoint kullanılır. Yalnızca kendi satış kanallarınıza bağlı siparişler döner; filtre, sıralama ve sayfalama parametreleri query string ile iletilir.

İstek

GET /api/orders
Accept: application/json
Authorization: Bearer YOUR_API_KEY

Sayfalama

ParametreVarsayılanAçıklama
per_page50Sayfa başına kayıt sayısı.
page1Sayfa numarası.

Yanıt, Laravel sayfalama zarfıyla (data, links, meta) döner.

Sıralama

sort parametresi alan:yön biçiminde verilir. Parametre gönderilmezse en yeni sipariş üstte olacak şekilde platform_date azalan sıralanır.

Sıralanabilir alanÖrnek
platform_date?sort=platform_date:desc
total?sort=total:asc

Filtreleme

Filtreler, fatura listesindeki ile aynı köşeli parantez sözdizimini ($eq, $contains, $or …) kullanır. Güvenlik nedeniyle yalnızca aşağıdaki alanlarda filtreleme yapılabilir; listede olmayan bir alan gönderirseniz filtre uygulanmaz.

AlanAçıklama
platform_d_idGörünen sipariş numarası.
platform_statusSiparişin platformdaki durumu.
platform_dateSipariş tarihi.
totalSipariş toplamı.
currencyPara birimi.
sale_channel_idSatış kanalı.
invoice_idFaturalanmış siparişleri ayıklamak için.
invoice_urlHarici fatura adresi olan siparişler.
created_atPanele düşme tarihi.
billingAddressFatura adresi alt alanları (örn. billingAddress][name).

Örnek — henüz faturalanmamış, belirli bir kanaldaki siparişler:

GET /api/orders?filters[sale_channel_id][$eq]=5&filters[invoice_id][$eq]=&sort=platform_date:desc&per_page=100

Örnek istekler

<?php
$q = http_build_query([
'filters[sale_channel_id][$eq]' => 5,
'sort' => 'platform_date:desc',
'per_page' => 100,
]);
$ch = curl_init('https://app.faturaentegrator.com/api/orders?' . $q);
curl_setopt_array($ch, [
CURLOPT_HTTPHEADER => ['Accept: application/json', 'Authorization: Bearer YOUR_API_KEY'],
CURLOPT_RETURNTRANSFER => true,
]);
$data = json_decode(curl_exec($ch), true);
curl_close($ch);

Örnek yanıt

Her kayıt satırları, adresleri, kargo bilgisini, satış kanalını ve (varsa) fatura özetini birlikte taşır.

{
"data": [
{
"id": 30,
"sale_channel_id": 5,
"platform_id": "ORD-2026-1001",
"platform_d_id": "1001",
"platform_status": "completed",
"platform_date": "2026-07-30T14:30:00.000000Z",
"total": "1250.50",
"currency": "TRY",
"payment_status": "paid",
"invoice_id": 812,
"invoice_url": null,
"billing_address": { "type": "person", "name": "Ahmet", "surname": "Yılmaz", "...": "..." },
"shipping_address": { "name": "Ahmet", "surname": "Yılmaz", "...": "..." },
"lines": [{ "id": 91, "name": "Kablosuz Kulaklık", "quantity": 2, "...": "..." }],
"shipment": { "company_title": "Yurtiçi Kargo", "...": "..." },
"sale_channel": { "id": 5, "title": "Kendi Mağazam", "...": "..." },
"invoice": {
"id": 812,
"workflow_status": "completed",
"formal_status": "completed",
"pdf_url": "https://app.faturaentegrator.com/storage/pdf/812.pdf"
}
}
],
"links": { "first": "...", "last": "...", "prev": null, "next": "..." },
"meta": { "current_page": 1, "per_page": 50, "total": 137, "last_page": 3 }
}
Faturalanmamış siparişleri bulma

invoice_id alanı null olan kayıtlar henüz faturalanmamıştır. invoice.workflow_status ise faturanın iş akışındaki durumunu gösterir — bkz. Sabitler.