API Referansı

Siparişler

Bağlı platformlardan düşen siparişlerin listelenmesi, durum ilerletme ve iptal akışı.
Taban URL
https://api.v1.fastsiparis.com
GET/web-api/v1/orders

Siparişleri Listele

Restorana düşen siparişleri listeler. `restaurantId`, `limit`, `cursor` ve yön belirten `dir` (`next`/`prev`) parametreleriyle sayfalanabilir.

Parametreler

AdKonumTipZorunluSeçenekler
restaurantIdquerystringHayır
limitqueryintegerHayır
cursorquerystringHayır
dirquerystringHayırnext / prev

Header'lar

AdDeğer
AuthorizationBearer POSENTEGRA_API_KEY

Kod Örneği

curl --request GET \
  --url 'https://api.v1.fastsiparis.com/web-api/v1/orders?restaurantId={restaurantId}&limit={limit}&cursor={cursor}&dir={dir}' \
  --header 'Authorization: Bearer POSENTEGRA_API_KEY'

Yanıtlar

200OK
JSON
{
  "success": true,
  "data": [
    {
      "id": "wo_1",
      "providerOrderId": "{orderId}",
      "restaurantId": "{restaurantId}"
    }
  ]
}
GET/web-api/v1/orders/{orderId}

Sipariş Detayı

Tek bir siparişin kalemleri, tutarı ve müşteri bilgisini döndürür.

Parametreler

AdKonumTipZorunluSeçenekler
orderIdpathstringEvet

Header'lar

AdDeğer
AuthorizationBearer POSENTEGRA_API_KEY

Kod Örneği

curl --request GET \
  --url 'https://api.v1.fastsiparis.com/web-api/v1/orders/{orderId}' \
  --header 'Authorization: Bearer POSENTEGRA_API_KEY'

Yanıtlar

200OK
JSON
{
  "success": true,
  "data": {
    "id": "wo_1",
    "pid": "{orderId}"
  }
}
POST/web-api/v1/orders/cancel/{orderId}

Siparişi İptal Et

Siparişi, platformun kabul ettiği bir neden koduyla iptal eder.

Parametreler

AdKonumTipZorunluSeçenekler
orderIdpathstringEvet

Gövde Alanları

AdTipZorunlu
reasonstringHayır

Header'lar

AdDeğer
AuthorizationBearer POSENTEGRA_API_KEY
Content-Typeapplication/json

İstek Gövdesi

JSON
{
  "reason": "TEST_REASON_CODE",
  "note": "Müşteri iptali"
}

Kod Örneği

curl --request POST \
  --url 'https://api.v1.fastsiparis.com/web-api/v1/orders/cancel/{orderId}' \
  --header 'Authorization: Bearer POSENTEGRA_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{  "reason": "TEST_REASON_CODE",  "note": "Müşteri iptali"}'

Yanıtlar

200OK
JSON
{
  "success": true,
  "data": {
    "orderId": "{orderId}",
    "status": 1600
  }
}
POST/web-api/v1/orders/change-status/{orderId}

Sipariş Durumunu İlerlet

Siparişi bir sonraki duruma taşır (hazırlanıyor, yolda, teslim edildi).

Parametreler

AdKonumTipZorunluSeçenekler
orderIdpathstringEvet

Header'lar

AdDeğer
AuthorizationBearer POSENTEGRA_API_KEY

Kod Örneği

curl --request POST \
  --url 'https://api.v1.fastsiparis.com/web-api/v1/orders/change-status/{orderId}' \
  --header 'Authorization: Bearer POSENTEGRA_API_KEY'

Yanıtlar

200OK
JSON
{
  "success": true,
  "data": {
    "orderId": "{orderId}",
    "oldStatus": 500,
    "newStatus": 600
  }
}
GET/web-api/v1/orders/reasons/{orderId}

İptal Nedenlerini Getir

Siparişin bağlı olduğu platformun kabul ettiği iptal nedenlerini döndürür.

Parametreler

AdKonumTipZorunluSeçenekler
orderIdpathstringEvet

Header'lar

AdDeğer
AuthorizationBearer POSENTEGRA_API_KEY

Kod Örneği

curl --request GET \
  --url 'https://api.v1.fastsiparis.com/web-api/v1/orders/reasons/{orderId}' \
  --header 'Authorization: Bearer POSENTEGRA_API_KEY'

Yanıtlar

200OK
JSON
{
  "success": true,
  "data": {
    "reasons": [
      {
        "id": "reason_1",
        "name": "Müşteri İptali"
      }
    ]
  }
}
POST/web-api/v1/orders/verify/{orderId}

Siparişi Doğrula

Siparişi onaylayarak hazırlanma akışına alır.

Parametreler

AdKonumTipZorunluSeçenekler
orderIdpathstringEvet

Header'lar

AdDeğer
AuthorizationBearer POSENTEGRA_API_KEY

Kod Örneği

curl --request POST \
  --url 'https://api.v1.fastsiparis.com/web-api/v1/orders/verify/{orderId}' \
  --header 'Authorization: Bearer POSENTEGRA_API_KEY'

Yanıtlar

200OK
JSON
{
  "success": true,
  "data": {
    "message": "Verify completed successfully",
    "provider": "yemeksepeti",
    "providerOrder": "{orderId}"
  }
}
POST/web-api/v1/orders/reports/mark

Siparişi Raporlandı Olarak İşaretle

Siparişi raporlandı olarak damgalar; listeden düşer.

Gövde Alanları

AdTipZorunlu
providerOrderIdstringEvet

Header'lar

AdDeğer
AuthorizationBearer POSENTEGRA_API_KEY
Content-Typeapplication/json

İstek Gövdesi

JSON
{
  "providerOrderId": "{providerOrderId}"
}

Kod Örneği

curl --request POST \
  --url 'https://api.v1.fastsiparis.com/web-api/v1/orders/reports/mark' \
  --header 'Authorization: Bearer POSENTEGRA_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{  "providerOrderId": "{providerOrderId}"}'

Yanıtlar

200OK
JSON
{
  "success": true,
  "data": {
    "providerOrderId": "{providerOrderId}",
    "isReport": true
  }
}
GET/web-api/v1/orders/reports/pending

Raporlanmamış Siparişleri Listele

Muhasebeye aktarılmayı bekleyen siparişleri döndürür.

Parametreler

AdKonumTipZorunluSeçenekler
restaurantIdquerystringHayır
limitqueryintegerHayır
cursorquerystringHayır
dirquerystringHayırnext / prev

Header'lar

AdDeğer
AuthorizationBearer POSENTEGRA_API_KEY

Kod Örneği

curl --request GET \
  --url 'https://api.v1.fastsiparis.com/web-api/v1/orders/reports/pending?restaurantId={restaurantId}&limit={limit}&cursor={cursor}&dir={dir}' \
  --header 'Authorization: Bearer POSENTEGRA_API_KEY'

Yanıtlar

200OK
JSON
{
  "success": true,
  "data": []
}
POST/web-api/v1/orders/retry-webhookkoleksiyon

Webhook Retry

Ulaşmayan webhook bildirimini yeniden gönderir.

Gövde Alanları

AdTipZorunlu
webhookOrderIdstringEvet
urlstringEvet
headersobjectEvet

Header'lar

AdDeğer
AuthorizationBearer POSENTEGRA_API_KEY
Content-Typeapplication/json

İstek Gövdesi

JSON
{
  "webhookOrderId": "{webhookOrderId}",
  "url": "https://example.com/webhook",
  "headers": {
    "X-Test": "true"
  }
}

Kod Örneği

curl --request POST \
  --url 'https://api.v1.fastsiparis.com/web-api/v1/orders/retry-webhook' \
  --header 'Authorization: Bearer POSENTEGRA_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{  "webhookOrderId": "{webhookOrderId}",  "url": "https://example.com/webhook",  "headers": {    "X-Test": "true"  }}'

Yanıtlar

200OK
JSON
{
  "success": true,
  "data": {
    "message": "webhook retry delivered",
    "statusCode": 200
  }
}
GET/web-api/v1/orders/grouped-paymentskoleksiyon

Gruplanmış Ödemeleri Getir

Siparişleri ödeme tipine göre gruplayıp toplamlarını döndürür.

Header'lar

AdDeğer
AuthorizationBearer POSENTEGRA_API_KEY

Kod Örneği

curl --request GET \
  --url 'https://api.v1.fastsiparis.com/web-api/v1/orders/grouped-payments' \
  --header 'Authorization: Bearer POSENTEGRA_API_KEY'

Yanıtlar

200OK
JSON
{
  "success": true
}